JoinConsumeRoom
Service to join a media consumption room, setup device, and manage piped transports.
joinConsumeRoom Joins a consumption room by sending a request to the server and performing necessary device and transport setup.
Options for joining the consumption room.
The remote socket used for joining the room.
API token for authentication.
API username for authentication.
Parameters required for the function.
A promise that resolves with the result of the join request.
const joinConsumeRoomResponse = await joinConsumeRoomService.joinConsumeRoom({ remote_sock: mySocket, apiToken: 'apiToken123', apiUserName: 'myUser', parameters: { roomName: 'room1', islevel: '2', member: 'JohnDoe', device: null, updateDevice: updateDeviceFunction, receiveAllPipedTransports: receiveAllPipedTransportsFunction, createDeviceClient: createDeviceClientFunction, }}); Copy
const joinConsumeRoomResponse = await joinConsumeRoomService.joinConsumeRoom({ remote_sock: mySocket, apiToken: 'apiToken123', apiUserName: 'myUser', parameters: { roomName: 'room1', islevel: '2', member: 'JohnDoe', device: null, updateDevice: updateDeviceFunction, receiveAllPipedTransports: receiveAllPipedTransportsFunction, createDeviceClient: createDeviceClientFunction, }});
Service
JoinConsumeRoom
Description
Service to join a media consumption room, setup device, and manage piped transports.
Method
joinConsumeRoom Joins a consumption room by sending a request to the server and performing necessary device and transport setup.
Param: options
Options for joining the consumption room.
Param: options.remote_sock
The remote socket used for joining the room.
Param: options.apiToken
API token for authentication.
Param: options.apiUserName
API username for authentication.
Param: options.parameters
Parameters required for the function.
Returns
A promise that resolves with the result of the join request.
Example