Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SessionProperties

Hierarchy

  • SessionProperties

Index

Properties

Optional customSessionId

customSessionId: string

Fix the sessionId that will be assigned to the session with this parameter. You can take advantage of this property to facilitate the mapping between OpenVidu Server 'session' entities and your own 'session' entities. If this parameter is undefined or an empty string, OpenVidu Server will generate a random sessionId for you.

Optional defaultCustomLayout

defaultCustomLayout: string

Default value used to initialize property RecordingProperties.customLayout of every recording of this session. This property can only be defined if SessionProperties.defaultRecordingLayout is set to RecordingLayout.CUSTOM.

You can easily override this value later by setting RecordingProperties.customLayout to any other value

Optional defaultOutputMode

defaultOutputMode: OutputMode

Default value used to initialize property RecordingProperties.outputMode of every recording of this session.

You can easily override this value later by setting RecordingProperties.outputMode to any other value

Optional defaultRecordingLayout

defaultRecordingLayout: RecordingLayout

Default value used to initialize property RecordingProperties.recordingLayout of every recording of this session.

You can easily override this value later by setting RecordingProperties.recordingLayout to any other value

Optional mediaMode

mediaMode: MediaMode

How the media streams will be sent and received by your clients: routed through OpenVidu Media Server (MediaMode.ROUTED) or attempting direct p2p connections (MediaMode.RELAYED, not available yet)

Optional recordingMode

recordingMode: RecordingMode

Whether the Session will be automatically recorded (RecordingMode.ALWAYS) or not (RecordingMode.MANUAL)

Generated using TypeDoc