Webex · Schema
LiveStreamObject
CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing
Properties
| Name | Type | Description |
|---|---|---|
| destination | string | A descriptive text to describe the destination of the live streaming. |
| rtmpUrl | string | Live streaming RTMP URL. |
| streamUrl | string | The URL to view the live streaming, i.e. the playback URL. |
| layoutWithoutSharedContent | string | Live streaming layout when there's no shared content. * `grid` - The video layout that allows you to see multiple participants in a meeting in grids. * `stack` - The video layout that displays the act |
| layoutWithSharedContent | string | Live streaming layout when there's shared content. * `stack` - The video layout that displays the shared content on the stage and up to six participants in thumbnails across the top. * `focusedContent |
| allowChangeLayoutInMeeting | boolean | Whether or not to allow change the live streaming layout in the meeitng. |
| followStageLayoutWhenSynced | boolean | Whether or not to follow the stage layout when it's being synchronized. |
| resolution | string | Resolution of the live streaming. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/LiveStreamObject",
"title": "LiveStreamObject",
"type": "object",
"required": [
"destination",
"rtmpUrl",
"streamUrl"
],
"properties": {
"destination": {
"type": "string",
"example": "Facebook",
"description": "A descriptive text to describe the destination of the live streaming."
},
"rtmpUrl": {
"type": "string",
"example": "rtmps://example.com:1935/MediaLive/WebexStreaming",
"description": "Live streaming RTMP URL."
},
"streamUrl": {
"type": "string",
"example": "https://example.com/Webex-Streaming/index_a.m3u8",
"description": "The URL to view the live streaming, i.e. the playback URL."
},
"layoutWithoutSharedContent": {
"type": "string",
"enum": [
"grid",
"stack",
"focus"
],
"description": "Live streaming layout when there's no shared content.\n * `grid` - The video layout that allows you to see multiple participants in a meeting in grids.\n * `stack` - The video layout that displays the active speaker on the stage and up to six participants in thumbnails across the top.\n * `focus` - The video layout that only displays the active speaker.\n"
},
"layoutWithSharedContent": {
"type": "string",
"enum": [
"stack",
"focusedContentWithActiveSpeaker",
"focusedContent"
],
"description": "Live streaming layout when there's shared content.\n * `stack` - The video layout that displays the shared content on the stage and up to six participants in thumbnails across the top.\n * `focusedContentWithActiveSpeaker` - The layout that displays the shared content in the main part of the screen and a large thumbnail of the active speaker in the upper right corner.\n * `focusedContent` - The layout that only displays the shared content in the main part of the screen and does not display the participants.\n"
},
"allowChangeLayoutInMeeting": {
"type": "boolean",
"description": "Whether or not to allow change the live streaming layout in the meeitng."
},
"followStageLayoutWhenSynced": {
"type": "boolean",
"example": true,
"description": "Whether or not to follow the stage layout when it's being synchronized."
},
"resolution": {
"type": "string",
"example": "1920x1080",
"description": "Resolution of the live streaming."
}
}
}