Class: LiveKit::RoomServiceClient

Inherits:
Twirp::Client
  • Object
show all
Includes:
AuthMixin
Defined in:
lib/livekit/room_service_client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from AuthMixin

#auth_header

Constructor Details

#initialize(base_url, api_key: nil, api_secret: nil) ⇒ RoomServiceClient

Returns a new instance of RoomServiceClient.



15
16
17
18
19
 
# File 'lib/livekit/room_service_client.rb', line 15

def initialize(base_url, api_key: nil, api_secret: nil)
  super(File.join(Utils.to_http_url(base_url), "/twirp"))
  @api_key = api_key
  @api_secret = api_secret
end

Instance Attribute Details

#api_key ⇒ Object

Returns the value of attribute api_key.



13
14
15
 
# File 'lib/livekit/room_service_client.rb', line 13

def api_key
  @api_key
end

#api_secret ⇒ Object

Returns the value of attribute api_secret.



13
14
15
 
# File 'lib/livekit/room_service_client.rb', line 13

def api_secret
  @api_secret
end

Instance Method Details

#create_room(name, empty_timeout: nil, max_participants: nil, egress: nil, metadata: nil, min_playout_delay: nil, max_playout_delay: nil, sync_streams: nil, departure_timeout: nil) ⇒ Object 



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/livekit/room_service_client.rb', line 21

def create_room(name,
    empty_timeout: nil,
    max_participants: nil,
    egress: nil,
    metadata: nil,
    min_playout_delay: nil,
    max_playout_delay: nil,
    sync_streams: nil,
    departure_timeout: nil
  )
  self.rpc(
    :CreateRoom,
    Proto::CreateRoomRequest.new(
      name: name,
      empty_timeout: empty_timeout,
      departure_timeout: departure_timeout,
      max_participants: max_participants,
      egress: egress,
      metadata: metadata,
      min_playout_delay: min_playout_delay,
      max_playout_delay: max_playout_delay,
      sync_streams: sync_streams
    ),
    headers:auth_header(video_grant: VideoGrant.new(roomCreate: true)),
  )
end

#delete_room(room:) ⇒ Object 



56
57
58
59
60
61
62
 
# File 'lib/livekit/room_service_client.rb', line 56

def delete_room(room:)
  self.rpc(
    :DeleteRoom,
    Proto::DeleteRoomRequest.new(room: room),
    headers:auth_header(video_grant: VideoGrant.new(roomCreate: true)),
  )
end

#get_participant(room:, identity:) ⇒ Object 



80
81
82
83
84
85
86
 
# File 'lib/livekit/room_service_client.rb', line 80

def get_participant(room:, identity:)
  self.rpc(
    :GetParticipant,
    Proto::RoomParticipantIdentity.new(room: room, identity: identity),
    headers:auth_header(video_grant: VideoGrant.new(roomAdmin: true, room: room)),
  )
end

#list_participants(room:) ⇒ Object 



72
73
74
75
76
77
78
 
# File 'lib/livekit/room_service_client.rb', line 72

def list_participants(room:)
  self.rpc(
    :ListParticipants,
    Proto::ListParticipantsRequest.new(room: room),
    headers:auth_header(video_grant: VideoGrant.new(roomAdmin: true, room: room)),
  )
end

#list_rooms(names: nil) ⇒ Object 



48
49
50
51
52
53
54
 
# File 'lib/livekit/room_service_client.rb', line 48

def list_rooms(names: nil)
  self.rpc(
    :ListRooms,
    Proto::ListRoomsRequest.new(names: names),
    headers:auth_header(video_grant: VideoGrant.new(roomList: true)),
  )
end

#mute_published_track(room:, identity:, track_sid:, muted:) ⇒ Object 



96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/livekit/room_service_client.rb', line 96

def mute_published_track(room:, identity:, track_sid:, muted:)
  self.rpc(
    :MutePublishedTrack,
    Proto::MuteRoomTrackRequest.new(
      room: room,
      identity: identity,
      track_sid: track_sid,
      muted: muted,
    ),
    headers:auth_header(video_grant: VideoGrant.new(roomAdmin: true, room: room)),
  )
end

#remove_participant(room:, identity:) ⇒ Object 



88
89
90
91
92
93
94
 
# File 'lib/livekit/room_service_client.rb', line 88

def remove_participant(room:, identity:)
  self.rpc(
    :RemoveParticipant,
    Proto::RoomParticipantIdentity.new(room: room, identity: identity),
    headers:auth_header(video_grant: VideoGrant.new(roomAdmin: true, room: room)),
  )
end

#send_data(room:, data:, kind:, destination_sids: [], destination_identities: []) ⇒ Object 



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/livekit/room_service_client.rb', line 154

def send_data(room:, data:, kind:,
    destination_sids: [],
    destination_identities: []
  )
  self.rpc(
    :SendData,
    Proto::SendDataRequest.new(
      room: room,
      data: data,
      kind: kind,
      destination_sids: destination_sids,
      destination_identities: destination_identities,
      nonce: SecureRandom.random_bytes(16)
    ),
    headers:auth_header(video_grant: VideoGrant.new(roomAdmin: true, room: room)),
  )
end

#update_participant(room:, identity:, metadata: nil, permission: nil, name: nil, attributes: nil) ⇒ Object 



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/livekit/room_service_client.rb', line 109

def update_participant(
    room:,
    identity:,
    metadata: nil,
    permission: nil,
    name: nil,
    attributes: nil
  )
  req = Proto::UpdateParticipantRequest.new(room: room, identity: identity)
  if metadata
    req.metadata = metadata
  end
  if permission
    req.permission = permission
  end
  if name
    req.name = name
  end
  if attributes
    attr_map = Google::Protobuf::Map.new(:string, :string)
    attributes.each do |k, v|
      attr_map[k.to_s] = v.to_s
    end
    req.attributes = attr_map
  end
  self.rpc(
    :UpdateParticipant,
    req,
    headers:auth_header(video_grant: VideoGrant.new(roomAdmin: true, room: room)),
  )
end

#update_room_metadata(room:, metadata:) ⇒ Object 



64
65
66
67
68
69
70
 
# File 'lib/livekit/room_service_client.rb', line 64

def update_room_metadata(room:, metadata:)
  self.rpc(
    :UpdateRoomMetadata,
    Proto::UpdateRoomMetadataRequest.new(room: room, metadata: metadata),
    headers:auth_header(video_grant: VideoGrant.new(roomAdmin: true, room: room)),
  )
end

#update_subscriptions(room:, identity:, track_sids:, subscribe:) ⇒ Object 



141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/livekit/room_service_client.rb', line 141

def update_subscriptions(room:, identity:, track_sids:, subscribe:)
  self.rpc(
    :UpdateSubscriptions,
    Proto::UpdateSubscriptionsRequest.new(
      room: room,
      identity: identity,
      track_sids: track_sids,
      subscribe: subscribe,
    ),
    headers:auth_header(video_grant: VideoGrant.new(roomAdmin: true, room: room)),
  )
end