-
Notifications
You must be signed in to change notification settings - Fork 6
/
meeting.LiveStreamState.yml
40 lines (40 loc) · 1.19 KB
/
meeting.LiveStreamState.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
### YamlMime:TSType
name: LiveStreamState
uid: '@microsoft/teams-js.meeting.LiveStreamState'
package: '@microsoft/teams-js'
summary: >-
Represents the current Real-Time Messaging Protocol (RTMP) live streaming
state of a meeting.
fullName: LiveStreamState
remarks: >-
RTMP is a popular communication protocol for streaming audio, video, and data
over the Internet.
isDeprecated: false
type: interface
properties:
- name: error
uid: '@microsoft/teams-js.meeting.LiveStreamState.error'
package: '@microsoft/teams-js'
summary: error object in case there is a failure
fullName: error
remarks: ''
isDeprecated: false
syntax:
content: 'error?: { code: string, message?: string }'
return:
description: ''
type: '{ code: string, message?: string }'
- name: isStreaming
uid: '@microsoft/teams-js.meeting.LiveStreamState.isStreaming'
package: '@microsoft/teams-js'
summary: >-
true when the current meeting is being streamed through RTMP, or false if
it is not.
fullName: isStreaming
remarks: ''
isDeprecated: false
syntax:
content: 'isStreaming: boolean'
return:
description: ''
type: boolean