Use this SDK to interact with LiveKit server APIs and create access tokens from your Ruby backend.
This library is designed to work with Ruby 2.6.0 and above.
Add this line to your application's Gemfile:
gem 'livekit-server-sdk'and then bundle install.
gem install livekit-server-sdkCreating a token for participant to join a room.
require 'livekit'
token = LiveKit::AccessToken.new(api_key: 'yourkey', api_secret: 'yoursecret')
token.identity = 'participant-identity'
token.name = 'participant-name'
token.video_grant = LiveKit::VideoGrant.new(roomJoin: true, room: 'room-name')
token.attributes = { "mykey" => "myvalue" }
puts token.to_jwtBy default, a token expires after 6 hours. You may override this by passing in ttl when creating the token. ttl is expressed in seconds.
It's possible to customize the permissions of each participant. See more details at access tokens guide.
RoomServiceClient is a Twirp-based client that provides management APIs to LiveKit. You can connect it to your LiveKit endpoint. See service apis for a list of available APIs.
require 'livekit'
client = LiveKit::RoomServiceClient.new('https://my.livekit.instance',
api_key: 'yourkey', api_secret: 'yoursecret')
name = 'myroom'
client.list_rooms
client.list_participants(room: name)
client.mute_published_track(room: name, identity: 'participant',
track_sid: 'track-id', muted: true)
client.remove_participant(room: name, identity: 'participant')
client.delete_room(room: name)EgressServiceClient is a ruby client to EgressService. Refer to docs for more usage examples
require 'livekit'
# starting a room composite to S3
egressClient = LiveKit::EgressServiceClient.new(
"https://your-url",
api_key: 'key',
api_secret: 'secret'
);
info = egressClient.start_room_composite_egress(
'room-name',
LiveKit::Proto::EncodedFileOutput.new(
file_type: LiveKit::Proto::EncodedFileType::MP4,
filepath: "my-recording.mp4",
s3: LiveKit::Proto::S3Upload.new(
access_key: 'access-key',
secret: 'secret',
region: 'bucket-region',
bucket: 'bucket'
)
)
)
puts info
# starting a track composite to RTMP
urls = Google::Protobuf::RepeatedField.new(:string, ['rtmp://url1', 'rtmps://url2'])
info = egressClient.start_track_composite_egress(
'room-name',
LiveKit::Proto::StreamOutput.new(
protocol: LiveKit::Proto::StreamProtocol::RTMP,
urls: urls
),
audio_track_id: 'TR_XXXXXXXXXXXX',
video_track_id: 'TR_XXXXXXXXXXXX'
)
puts infoYou may store credentials in environment variables. If api-key or api-secret is not passed in when creating a RoomServiceClient or AccessToken, the values in the following env vars will be used:
LIVEKIT_API_KEYLIVEKIT_API_SECRET
The gem is available as open source under the terms of Apache 2.0 License.
| LiveKit Ecosystem | |
|---|---|
| Realtime SDKs | React Components · Browser · Swift Components · iOS/macOS/visionOS · Android · Flutter · React Native · Rust · Node.js · Python · Unity (web) · Unity (beta) |
| Server APIs | Node.js · Golang · Ruby · Java/Kotlin · Python · Rust · PHP (community) |
| Agents Frameworks | Python · Playground |
| Services | LiveKit server · Egress · Ingress · SIP |
| Resources | Docs · Example apps · Cloud · Self-hosting · CLI |