From 739c5ebf8f24aef674c9b75fa1036389bc7b071d Mon Sep 17 00:00:00 2001 From: GH Action CI Stream Date: Fri, 22 Sep 2023 18:45:56 +0000 Subject: [PATCH] Update video openapi Spec --- openapi/video-openapi-clientside.yaml | 236 +++++++++++--------- openapi/video-openapi.yaml | 308 +++++++++++++++++--------- 2 files changed, 338 insertions(+), 206 deletions(-) diff --git a/openapi/video-openapi-clientside.yaml b/openapi/video-openapi-clientside.yaml index 1cf42cea..f5a88ab2 100644 --- a/openapi/video-openapi-clientside.yaml +++ b/openapi/video-openapi-clientside.yaml @@ -198,26 +198,26 @@ components: x-stream-event-call-type: true x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - BroadcastSettings: + BroadcastSettingsRequest: properties: enabled: type: boolean x-stream-index: "001" hls: - $ref: '#/components/schemas/HLSSettings' + $ref: '#/components/schemas/HLSSettingsRequest' x-stream-index: "002" - required: - - enabled - - hls type: object - BroadcastSettingsRequest: + BroadcastSettingsResponse: properties: enabled: type: boolean x-stream-index: "001" hls: - $ref: '#/components/schemas/HLSSettingsRequest' + $ref: '#/components/schemas/HLSSettingsResponse' x-stream-index: "002" + required: + - enabled + - hls type: object CallAcceptedEvent: description: This event is sent when a user accepts a notification to join a @@ -256,9 +256,17 @@ components: x-stream-event-call-type: true x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallBroadcastingStartedEvent: - description: This event is sent when call broadcasting has started + CallCreatedEvent: + description: "This event is sent when a call is created. Clients receiving this + event should check if the ringing \nfield is set to true and if so, show the + call screen" + nullable: true properties: + call: + $ref: '#/components/schemas/CallResponse' + description: Call object + title: Call + x-stream-index: "003" call_cid: type: string x-stream-index: "002.001" @@ -266,12 +274,16 @@ components: format: date-time type: string x-stream-index: "001.002" - hls_playlist_url: - type: string - x-stream-index: "003" + members: + description: the members added to this call + items: + $ref: '#/components/schemas/MemberResponse' + title: Members + type: array + x-stream-index: "004" type: - default: call.broadcasting_started - description: 'The type of event: "call.broadcasting_started" in this case' + default: call.created + description: 'The type of event: "call.created" in this case' title: Event Type type: string x-stream-index: "001.001" @@ -279,15 +291,21 @@ components: - type - created_at - call_cid - - hls_playlist_url - title: CallBroadcastingStartedEvent + - call + - members + title: CallCreatedEvent type: object x-stream-event-call-type: true x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallBroadcastingStoppedEvent: - description: This event is sent when call broadcasting has stopped + CallEndedEvent: + description: This event is sent when a call is mark as ended for all its participants. + Clients receiving this event should leave the call screen + nullable: true properties: + call: + $ref: '#/components/schemas/CallResponse' + x-stream-index: "003" call_cid: type: string x-stream-index: "002.001" @@ -296,31 +314,30 @@ components: type: string x-stream-index: "001.002" type: - default: call.broadcasting_stopped - description: 'The type of event: "call.broadcasting_stopped" in this case' + default: call.ended + description: 'The type of event: "call.ended" in this case' title: Event Type type: string x-stream-index: "001.001" + user: + $ref: '#/components/schemas/UserResponse' + description: The user who ended the call, null if the call was ended by + the server + title: User + x-stream-index: "004" required: - type - created_at - call_cid - title: CallBroadcastingStoppedEvent + - call + title: CallEndedEvent type: object x-stream-event-call-type: true x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallCreatedEvent: - description: "This event is sent when a call is created. Clients receiving this - event should check if the ringing \nfield is set to true and if so, show the - call screen" - nullable: true + CallHLSBroadcastingStartedEvent: + description: This event is sent when HLS broadcasting has started properties: - call: - $ref: '#/components/schemas/CallResponse' - description: Call object - title: Call - x-stream-index: "003" call_cid: type: string x-stream-index: "002.001" @@ -328,16 +345,13 @@ components: format: date-time type: string x-stream-index: "001.002" - members: - description: the members added to this call - items: - $ref: '#/components/schemas/MemberResponse' - title: Members - type: array - x-stream-index: "004" + hls_playlist_url: + type: string + x-stream-index: "003" type: - default: call.created - description: 'The type of event: "call.created" in this case' + default: call.hls_broadcasting_started + description: 'The type of event: "call.hls_broadcasting_started" in this + case' title: Event Type type: string x-stream-index: "001.001" @@ -345,21 +359,15 @@ components: - type - created_at - call_cid - - call - - members - title: CallCreatedEvent + - hls_playlist_url + title: CallHLSBroadcastingStartedEvent type: object x-stream-event-call-type: true x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallEndedEvent: - description: This event is sent when a call is mark as ended for all its participants. - Clients receiving this event should leave the call screen - nullable: true + CallHLSBroadcastingStoppedEvent: + description: This event is sent when HLS broadcasting has stopped properties: - call: - $ref: '#/components/schemas/CallResponse' - x-stream-index: "003" call_cid: type: string x-stream-index: "002.001" @@ -368,23 +376,17 @@ components: type: string x-stream-index: "001.002" type: - default: call.ended - description: 'The type of event: "call.ended" in this case' + default: call.hls_broadcasting_stopped + description: 'The type of event: "call.hls_broadcasting_stopped" in this + case' title: Event Type type: string x-stream-index: "001.001" - user: - $ref: '#/components/schemas/UserResponse' - description: The user who ended the call, null if the call was ended by - the server - title: User - x-stream-index: "004" required: - type - created_at - call_cid - - call - title: CallEndedEvent + title: CallHLSBroadcastingStoppedEvent type: object x-stream-event-call-type: true x-stream-is-event: true @@ -974,6 +976,9 @@ components: team: type: string x-stream-index: "006" + thumbnails: + $ref: '#/components/schemas/ThumbnailResponse' + x-stream-index: "021" transcribing: type: boolean x-stream-index: "012" @@ -1283,6 +1288,9 @@ components: screensharing: $ref: '#/components/schemas/ScreensharingSettingsRequest' x-stream-index: "007" + thumbnails: + $ref: '#/components/schemas/ThumbnailsSettingsRequest' + x-stream-index: "010" transcription: $ref: '#/components/schemas/TranscriptionSettingsRequest' x-stream-index: "008" @@ -1299,13 +1307,13 @@ components: $ref: '#/components/schemas/BackstageSettings' x-stream-index: "002" broadcasting: - $ref: '#/components/schemas/BroadcastSettings' + $ref: '#/components/schemas/BroadcastSettingsResponse' x-stream-index: "003" geofencing: $ref: '#/components/schemas/GeofenceSettings' x-stream-index: "004" recording: - $ref: '#/components/schemas/RecordSettings' + $ref: '#/components/schemas/RecordSettingsResponse' x-stream-index: "005" ring: $ref: '#/components/schemas/RingSettings' @@ -1313,6 +1321,9 @@ components: screensharing: $ref: '#/components/schemas/ScreensharingSettings' x-stream-index: "007" + thumbnails: + $ref: '#/components/schemas/ThumbnailsSettings' + x-stream-index: "010" transcription: $ref: '#/components/schemas/TranscriptionSettings' x-stream-index: "008" @@ -1329,6 +1340,7 @@ components: - screensharing - transcription - video + - thumbnails type: object CallStateResponseFields: properties: @@ -1921,7 +1933,7 @@ components: - call - duration type: object - HLSSettings: + HLSSettingsRequest: properties: auto_on: type: boolean @@ -1932,14 +1944,12 @@ components: quality_tracks: items: type: string + maximum: 3 + minimum: 1 type: array x-stream-index: "003" - required: - - auto_on - - enabled - - quality_tracks type: object - HLSSettingsRequest: + HLSSettingsResponse: properties: auto_on: type: boolean @@ -1952,6 +1962,10 @@ components: type: string type: array x-stream-index: "003" + required: + - auto_on + - enabled + - quality_tracks type: object HealthCheckEvent: nullable: true @@ -2491,7 +2505,7 @@ components: - user - type type: object - RecordSettings: + RecordSettingsRequest: properties: audio_only: type: boolean @@ -2505,7 +2519,6 @@ components: x-stream-index: "002" quality: enum: - - audio-only - 360p - 480p - 720p @@ -2514,32 +2527,23 @@ components: type: string x-stream-index: "003" required: - - audio_only - mode - - quality type: object - RecordSettingsRequest: + RecordSettingsResponse: properties: audio_only: type: boolean x-stream-index: "001" mode: - enum: - - available - - disabled - - auto-on type: string x-stream-index: "002" quality: - enum: - - audio-only - - 360p - - 480p - - 720p - - 1080p - - 1440p type: string x-stream-index: "003" + required: + - audio_only + - mode + - quality type: object RejectCallRequest: nullable: true @@ -2710,10 +2714,10 @@ components: type: string x-stream-index: "001" type: object - StartBroadcastingRequest: + StartHLSBroadcastingRequest: nullable: true type: object - StartBroadcastingResponse: + StartHLSBroadcastingResponse: nullable: true properties: duration: @@ -2752,10 +2756,10 @@ components: required: - duration type: object - StopBroadcastingRequest: + StopHLSBroadcastingRequest: nullable: true type: object - StopBroadcastingResponse: + StopHLSBroadcastingResponse: nullable: true properties: duration: @@ -2856,6 +2860,28 @@ components: type: integer x-stream-index: "001" type: object + ThumbnailResponse: + properties: + image_url: + type: string + x-stream-index: "001" + required: + - image_url + type: object + ThumbnailsSettings: + properties: + enabled: + type: boolean + x-stream-index: "001" + required: + - enabled + type: object + ThumbnailsSettingsRequest: + properties: + enabled: + type: boolean + x-stream-index: "001" + type: object TranscriptionSettings: properties: closed_caption_mode: @@ -3203,10 +3229,10 @@ components: mapping: call.accepted: '#/components/schemas/CallAcceptedEvent' call.blocked_user: '#/components/schemas/BlockedUserEvent' - call.broadcasting_started: '#/components/schemas/CallBroadcastingStartedEvent' - call.broadcasting_stopped: '#/components/schemas/CallBroadcastingStoppedEvent' call.created: '#/components/schemas/CallCreatedEvent' call.ended: '#/components/schemas/CallEndedEvent' + call.hls_broadcasting_started: '#/components/schemas/CallHLSBroadcastingStartedEvent' + call.hls_broadcasting_stopped: '#/components/schemas/CallHLSBroadcastingStoppedEvent' call.live_started: '#/components/schemas/CallLiveStartedEvent' call.member_added: '#/components/schemas/CallMemberAddedEvent' call.member_removed: '#/components/schemas/CallMemberRemovedEvent' @@ -3237,10 +3263,10 @@ components: oneOf: - $ref: '#/components/schemas/BlockedUserEvent' - $ref: '#/components/schemas/CallAcceptedEvent' - - $ref: '#/components/schemas/CallBroadcastingStartedEvent' - - $ref: '#/components/schemas/CallBroadcastingStoppedEvent' - $ref: '#/components/schemas/CallCreatedEvent' - $ref: '#/components/schemas/CallEndedEvent' + - $ref: '#/components/schemas/CallHLSBroadcastingStartedEvent' + - $ref: '#/components/schemas/CallHLSBroadcastingStoppedEvent' - $ref: '#/components/schemas/CallLiveStartedEvent' - $ref: '#/components/schemas/CallMemberAddedEvent' - $ref: '#/components/schemas/CallMemberRemovedEvent' @@ -3389,7 +3415,7 @@ externalDocs: url: https://getstream.io/video/docs/ info: title: Stream Video API - version: v88.13.0 + version: v89.0.0 openapi: 3.0.3 paths: /call/{type}/{id}: @@ -4717,17 +4743,19 @@ paths: /call/{type}/{id}/start_broadcasting: post: description: | - Starts broadcasting + Starts HLS broadcasting Required permissions: - StartBroadcasting - operationId: StartBroadcasting + operationId: StartHLSBroadcasting parameters: - in: path name: type required: true schema: + description: The type of call maxLength: 64 + title: Type type: string writeOnly: true x-stream-index: "001.001" @@ -4735,7 +4763,9 @@ paths: name: id required: true schema: + description: Call ID maxLength: 64 + title: ID type: string writeOnly: true x-stream-index: "001.002" @@ -4744,7 +4774,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/StartBroadcastingResponse' + $ref: '#/components/schemas/StartHLSBroadcastingResponse' description: Successful response "400": content: @@ -4771,9 +4801,9 @@ paths: description: Timestamp when number of requests will be reset schema: type: integer - summary: Start broadcasting + summary: Start HLS broadcasting x-stream-permissions: - StartBroadcasting: To start broadcasting + StartBroadcasting: To start HLS broadcasting /call/{type}/{id}/start_recording: post: description: | @@ -4915,11 +4945,11 @@ paths: /call/{type}/{id}/stop_broadcasting: post: description: | - Stops broadcasting + Stops HLS broadcasting Required permissions: - StopBroadcasting - operationId: StopBroadcasting + operationId: StopHLSBroadcasting parameters: - in: path name: type @@ -4942,7 +4972,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/StopBroadcastingResponse' + $ref: '#/components/schemas/StopHLSBroadcastingResponse' description: Successful response "400": content: @@ -4969,9 +4999,9 @@ paths: description: Timestamp when number of requests will be reset schema: type: integer - summary: Stop broadcasting + summary: Stop HLS broadcasting x-stream-permissions: - StopBroadcasting: Allows the user to stop broadcasting + StopBroadcasting: Allows the user to stop HLS broadcasting /call/{type}/{id}/stop_live: post: description: |2 diff --git a/openapi/video-openapi.yaml b/openapi/video-openapi.yaml index ca9455b7..839fc19b 100644 --- a/openapi/video-openapi.yaml +++ b/openapi/video-openapi.yaml @@ -219,26 +219,26 @@ components: x-stream-event-call-type: true x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - BroadcastSettings: + BroadcastSettingsRequest: properties: enabled: type: boolean x-stream-index: "001" hls: - $ref: '#/components/schemas/HLSSettings' + $ref: '#/components/schemas/HLSSettingsRequest' x-stream-index: "002" - required: - - enabled - - hls type: object - BroadcastSettingsRequest: + BroadcastSettingsResponse: properties: enabled: type: boolean x-stream-index: "001" hls: - $ref: '#/components/schemas/HLSSettingsRequest' + $ref: '#/components/schemas/HLSSettingsResponse' x-stream-index: "002" + required: + - enabled + - hls type: object CallAcceptedEvent: description: This event is sent when a user accepts a notification to join a @@ -277,9 +277,17 @@ components: x-stream-event-call-type: true x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallBroadcastingStartedEvent: - description: This event is sent when call broadcasting has started + CallCreatedEvent: + description: "This event is sent when a call is created. Clients receiving this + event should check if the ringing \nfield is set to true and if so, show the + call screen" + nullable: true properties: + call: + $ref: '#/components/schemas/CallResponse' + description: Call object + title: Call + x-stream-index: "003" call_cid: type: string x-stream-index: "002.001" @@ -287,12 +295,16 @@ components: format: date-time type: string x-stream-index: "001.002" - hls_playlist_url: - type: string - x-stream-index: "003" + members: + description: the members added to this call + items: + $ref: '#/components/schemas/MemberResponse' + title: Members + type: array + x-stream-index: "004" type: - default: call.broadcasting_started - description: 'The type of event: "call.broadcasting_started" in this case' + default: call.created + description: 'The type of event: "call.created" in this case' title: Event Type type: string x-stream-index: "001.001" @@ -300,15 +312,21 @@ components: - type - created_at - call_cid - - hls_playlist_url - title: CallBroadcastingStartedEvent + - call + - members + title: CallCreatedEvent type: object x-stream-event-call-type: true x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallBroadcastingStoppedEvent: - description: This event is sent when call broadcasting has stopped + CallEndedEvent: + description: This event is sent when a call is mark as ended for all its participants. + Clients receiving this event should leave the call screen + nullable: true properties: + call: + $ref: '#/components/schemas/CallResponse' + x-stream-index: "003" call_cid: type: string x-stream-index: "002.001" @@ -317,31 +335,30 @@ components: type: string x-stream-index: "001.002" type: - default: call.broadcasting_stopped - description: 'The type of event: "call.broadcasting_stopped" in this case' + default: call.ended + description: 'The type of event: "call.ended" in this case' title: Event Type type: string x-stream-index: "001.001" + user: + $ref: '#/components/schemas/UserResponse' + description: The user who ended the call, null if the call was ended by + the server + title: User + x-stream-index: "004" required: - type - created_at - call_cid - title: CallBroadcastingStoppedEvent + - call + title: CallEndedEvent type: object x-stream-event-call-type: true x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallCreatedEvent: - description: "This event is sent when a call is created. Clients receiving this - event should check if the ringing \nfield is set to true and if so, show the - call screen" - nullable: true + CallHLSBroadcastingStartedEvent: + description: This event is sent when HLS broadcasting has started properties: - call: - $ref: '#/components/schemas/CallResponse' - description: Call object - title: Call - x-stream-index: "003" call_cid: type: string x-stream-index: "002.001" @@ -349,16 +366,13 @@ components: format: date-time type: string x-stream-index: "001.002" - members: - description: the members added to this call - items: - $ref: '#/components/schemas/MemberResponse' - title: Members - type: array - x-stream-index: "004" + hls_playlist_url: + type: string + x-stream-index: "003" type: - default: call.created - description: 'The type of event: "call.created" in this case' + default: call.hls_broadcasting_started + description: 'The type of event: "call.hls_broadcasting_started" in this + case' title: Event Type type: string x-stream-index: "001.001" @@ -366,21 +380,15 @@ components: - type - created_at - call_cid - - call - - members - title: CallCreatedEvent + - hls_playlist_url + title: CallHLSBroadcastingStartedEvent type: object x-stream-event-call-type: true x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallEndedEvent: - description: This event is sent when a call is mark as ended for all its participants. - Clients receiving this event should leave the call screen - nullable: true + CallHLSBroadcastingStoppedEvent: + description: This event is sent when HLS broadcasting has stopped properties: - call: - $ref: '#/components/schemas/CallResponse' - x-stream-index: "003" call_cid: type: string x-stream-index: "002.001" @@ -389,23 +397,17 @@ components: type: string x-stream-index: "001.002" type: - default: call.ended - description: 'The type of event: "call.ended" in this case' + default: call.hls_broadcasting_stopped + description: 'The type of event: "call.hls_broadcasting_stopped" in this + case' title: Event Type type: string x-stream-index: "001.001" - user: - $ref: '#/components/schemas/UserResponse' - description: The user who ended the call, null if the call was ended by - the server - title: User - x-stream-index: "004" required: - type - created_at - call_cid - - call - title: CallEndedEvent + title: CallHLSBroadcastingStoppedEvent type: object x-stream-event-call-type: true x-stream-is-event: true @@ -1005,6 +1007,9 @@ components: team: type: string x-stream-index: "006" + thumbnails: + $ref: '#/components/schemas/ThumbnailResponse' + x-stream-index: "021" transcribing: type: boolean x-stream-index: "012" @@ -1314,6 +1319,9 @@ components: screensharing: $ref: '#/components/schemas/ScreensharingSettingsRequest' x-stream-index: "007" + thumbnails: + $ref: '#/components/schemas/ThumbnailsSettingsRequest' + x-stream-index: "010" transcription: $ref: '#/components/schemas/TranscriptionSettingsRequest' x-stream-index: "008" @@ -1330,13 +1338,13 @@ components: $ref: '#/components/schemas/BackstageSettings' x-stream-index: "002" broadcasting: - $ref: '#/components/schemas/BroadcastSettings' + $ref: '#/components/schemas/BroadcastSettingsResponse' x-stream-index: "003" geofencing: $ref: '#/components/schemas/GeofenceSettings' x-stream-index: "004" recording: - $ref: '#/components/schemas/RecordSettings' + $ref: '#/components/schemas/RecordSettingsResponse' x-stream-index: "005" ring: $ref: '#/components/schemas/RingSettings' @@ -1344,6 +1352,9 @@ components: screensharing: $ref: '#/components/schemas/ScreensharingSettings' x-stream-index: "007" + thumbnails: + $ref: '#/components/schemas/ThumbnailsSettings' + x-stream-index: "010" transcription: $ref: '#/components/schemas/TranscriptionSettings' x-stream-index: "008" @@ -1360,6 +1371,7 @@ components: - screensharing - transcription - video + - thumbnails type: object CallStateResponseFields: properties: @@ -2107,7 +2119,7 @@ components: - call - duration type: object - HLSSettings: + HLSSettingsRequest: properties: auto_on: type: boolean @@ -2115,17 +2127,20 @@ components: enabled: type: boolean x-stream-index: "002" + layout: + $ref: '#/components/schemas/LayoutSettingsRequest' + title: LayoutSettings + x-backend-only: true + x-stream-index: "004" quality_tracks: items: type: string + maximum: 3 + minimum: 1 type: array x-stream-index: "003" - required: - - auto_on - - enabled - - quality_tracks type: object - HLSSettingsRequest: + HLSSettingsResponse: properties: auto_on: type: boolean @@ -2133,11 +2148,21 @@ components: enabled: type: boolean x-stream-index: "002" + layout: + $ref: '#/components/schemas/LayoutSettings' + title: Layout + x-backend-only: true + x-stream-index: "004" quality_tracks: items: type: string type: array x-stream-index: "003" + required: + - auto_on + - enabled + - quality_tracks + - layout type: object HealthCheckEvent: nullable: true @@ -2261,6 +2286,56 @@ components: - credentials - duration type: object + LayoutSettings: + properties: + external_app_url: + type: string + x-stream-index: "003" + external_css_url: + type: string + x-stream-index: "004" + name: + enum: + - spotlight + - grid + - single-participant + - mobile + - custom + type: string + x-stream-index: "001" + options: + additionalProperties: {} + type: object + x-stream-index: "002" + required: + - name + - external_app_url + - external_css_url + type: object + LayoutSettingsRequest: + properties: + external_app_url: + type: string + x-stream-index: "003" + external_css_url: + type: string + x-stream-index: "004" + name: + enum: + - spotlight + - grid + - single-participant + - mobile + - custom + type: string + x-stream-index: "001" + options: + additionalProperties: {} + type: object + x-stream-index: "002" + required: + - name + type: object ListCallTypeResponse: nullable: true properties: @@ -2734,11 +2809,16 @@ components: - user - type type: object - RecordSettings: + RecordSettingsRequest: properties: audio_only: type: boolean x-stream-index: "001" + layout: + $ref: '#/components/schemas/LayoutSettingsRequest' + title: LayoutSettings + x-backend-only: true + x-stream-index: "004" mode: enum: - available @@ -2748,7 +2828,6 @@ components: x-stream-index: "002" quality: enum: - - audio-only - 360p - 480p - 720p @@ -2757,32 +2836,29 @@ components: type: string x-stream-index: "003" required: - - audio_only - mode - - quality type: object - RecordSettingsRequest: + RecordSettingsResponse: properties: audio_only: type: boolean x-stream-index: "001" + layout: + $ref: '#/components/schemas/LayoutSettings' + title: Layout + x-backend-only: true + x-stream-index: "004" mode: - enum: - - available - - disabled - - auto-on type: string x-stream-index: "002" quality: - enum: - - audio-only - - 360p - - 480p - - 720p - - 1080p - - 1440p type: string x-stream-index: "003" + required: + - audio_only + - mode + - quality + - layout type: object RejectCallRequest: nullable: true @@ -2955,10 +3031,10 @@ components: type: string x-stream-index: "001" type: object - StartBroadcastingRequest: + StartHLSBroadcastingRequest: nullable: true type: object - StartBroadcastingResponse: + StartHLSBroadcastingResponse: nullable: true properties: duration: @@ -2997,10 +3073,10 @@ components: required: - duration type: object - StopBroadcastingRequest: + StopHLSBroadcastingRequest: nullable: true type: object - StopBroadcastingResponse: + StopHLSBroadcastingResponse: nullable: true properties: duration: @@ -3101,6 +3177,28 @@ components: type: integer x-stream-index: "001" type: object + ThumbnailResponse: + properties: + image_url: + type: string + x-stream-index: "001" + required: + - image_url + type: object + ThumbnailsSettings: + properties: + enabled: + type: boolean + x-stream-index: "001" + required: + - enabled + type: object + ThumbnailsSettingsRequest: + properties: + enabled: + type: boolean + x-stream-index: "001" + type: object TranscriptionSettings: properties: closed_caption_mode: @@ -3516,10 +3614,10 @@ components: mapping: call.accepted: '#/components/schemas/CallAcceptedEvent' call.blocked_user: '#/components/schemas/BlockedUserEvent' - call.broadcasting_started: '#/components/schemas/CallBroadcastingStartedEvent' - call.broadcasting_stopped: '#/components/schemas/CallBroadcastingStoppedEvent' call.created: '#/components/schemas/CallCreatedEvent' call.ended: '#/components/schemas/CallEndedEvent' + call.hls_broadcasting_started: '#/components/schemas/CallHLSBroadcastingStartedEvent' + call.hls_broadcasting_stopped: '#/components/schemas/CallHLSBroadcastingStoppedEvent' call.live_started: '#/components/schemas/CallLiveStartedEvent' call.member_added: '#/components/schemas/CallMemberAddedEvent' call.member_removed: '#/components/schemas/CallMemberRemovedEvent' @@ -3550,10 +3648,10 @@ components: oneOf: - $ref: '#/components/schemas/BlockedUserEvent' - $ref: '#/components/schemas/CallAcceptedEvent' - - $ref: '#/components/schemas/CallBroadcastingStartedEvent' - - $ref: '#/components/schemas/CallBroadcastingStoppedEvent' - $ref: '#/components/schemas/CallCreatedEvent' - $ref: '#/components/schemas/CallEndedEvent' + - $ref: '#/components/schemas/CallHLSBroadcastingStartedEvent' + - $ref: '#/components/schemas/CallHLSBroadcastingStoppedEvent' - $ref: '#/components/schemas/CallLiveStartedEvent' - $ref: '#/components/schemas/CallMemberAddedEvent' - $ref: '#/components/schemas/CallMemberRemovedEvent' @@ -3702,7 +3800,7 @@ externalDocs: url: https://getstream.io/video/docs/ info: title: Stream Video API - version: v88.13.0 + version: v89.0.0 openapi: 3.0.3 paths: /call/{type}/{id}: @@ -5030,17 +5128,19 @@ paths: /call/{type}/{id}/start_broadcasting: post: description: | - Starts broadcasting + Starts HLS broadcasting Required permissions: - StartBroadcasting - operationId: StartBroadcasting + operationId: StartHLSBroadcasting parameters: - in: path name: type required: true schema: + description: The type of call maxLength: 64 + title: Type type: string writeOnly: true x-stream-index: "001.001" @@ -5048,7 +5148,9 @@ paths: name: id required: true schema: + description: Call ID maxLength: 64 + title: ID type: string writeOnly: true x-stream-index: "001.002" @@ -5057,7 +5159,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/StartBroadcastingResponse' + $ref: '#/components/schemas/StartHLSBroadcastingResponse' description: Successful response "400": content: @@ -5084,9 +5186,9 @@ paths: description: Timestamp when number of requests will be reset schema: type: integer - summary: Start broadcasting + summary: Start HLS broadcasting x-stream-permissions: - StartBroadcasting: To start broadcasting + StartBroadcasting: To start HLS broadcasting /call/{type}/{id}/start_recording: post: description: | @@ -5228,11 +5330,11 @@ paths: /call/{type}/{id}/stop_broadcasting: post: description: | - Stops broadcasting + Stops HLS broadcasting Required permissions: - StopBroadcasting - operationId: StopBroadcasting + operationId: StopHLSBroadcasting parameters: - in: path name: type @@ -5255,7 +5357,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/StopBroadcastingResponse' + $ref: '#/components/schemas/StopHLSBroadcastingResponse' description: Successful response "400": content: @@ -5282,9 +5384,9 @@ paths: description: Timestamp when number of requests will be reset schema: type: integer - summary: Stop broadcasting + summary: Stop HLS broadcasting x-stream-permissions: - StopBroadcasting: Allows the user to stop broadcasting + StopBroadcasting: Allows the user to stop HLS broadcasting /call/{type}/{id}/stop_live: post: description: |2