createScreenShareObject

Deprecated

createScreenShareObject(opts): Promise<RoomSessionScreenShare> - See RoomSessionScreenShare documentation for more details.

Deprecated. Use startScreenShare instead.

Adds a screen sharing instance to the room. You can create multiple screen sharing instances and add all of them to the room.

object

Object containing the parameters of the method.

boolean | MediaTrackConstraints

Audio constraints to use when joining the room. Default: true.

boolean

Whether the screen share object should automatically join the room.

boolean | MediaTrackConstraints

Video constraints to use when joining the room. Default: true.

Promise<RoomSessionScreenShare> - See RoomSessionScreenShare documentation for more details.

You need to specify the permissions when creating the Video Room Token on the server side.

Sharing the screen together with the associated audio:

1 await roomSession.createScreenShareObject({ audio: true, video: true });