/ fm / liveswitch / PeerConnectionOffer
Class: PeerConnectionOffer
fm.liveswitch.PeerConnectionOffer
A peer connection offer.
Table of contents
Methods
- accept
- addOnCancel
- fmliveswitchPeerConnectionOfferInit
- getChannel
- getConnectionTag
- getHasAudio
- getHasData
- getHasVideo
- getOffer
- getRemoteClientInfo
- getRemoteClosed
- getRemoteConnectionId
- getRemoteFailed
- getTypeString
- reject
- removeOnCancel
Methods
accept
▸ accept(audioStream: AudioStream): PeerConnection
Accepts the offer.
Parameters:
| Name | Type | Description |
|---|---|---|
audioStream |
AudioStream | The audio stream. |
Returns: PeerConnection
Defined in: Generated/TypeScript/fm.liveswitch/PeerConnectionOffer.ts:95
▸ accept(audioStream: AudioStream, dataStream: DataStream): PeerConnection
Accepts the offer.
Parameters:
| Name | Type | Description |
|---|---|---|
audioStream |
AudioStream | The audio stream. |
dataStream |
DataStream | The data stream. |
Returns: PeerConnection
Defined in: Generated/TypeScript/fm.liveswitch/PeerConnectionOffer.ts:103
▸ accept(audioStream: AudioStream, videoStream: VideoStream): PeerConnection
Accepts the offer.
Parameters:
| Name | Type | Description |
|---|---|---|
audioStream |
AudioStream | The audio stream. |
videoStream |
VideoStream | The video stream. |
Returns: PeerConnection
Defined in: Generated/TypeScript/fm.liveswitch/PeerConnectionOffer.ts:111
▸ accept(audioStream: AudioStream, videoStream: VideoStream, dataStream: DataStream): PeerConnection
Accepts the offer.
Parameters:
| Name | Type | Description |
|---|---|---|
audioStream |
AudioStream | The audio stream. |
videoStream |
VideoStream | The video stream. |
dataStream |
DataStream | The data stream. |
Returns: PeerConnection
Defined in: Generated/TypeScript/fm.liveswitch/PeerConnectionOffer.ts:120
▸ accept(dataStream: DataStream): PeerConnection
Accepts the offer.
Parameters:
| Name | Type | Description |
|---|---|---|
dataStream |
DataStream | The data stream. |
Returns: PeerConnection
Defined in: Generated/TypeScript/fm.liveswitch/PeerConnectionOffer.ts:127
▸ accept(videoStream: VideoStream): PeerConnection
Accepts the offer.
Parameters:
| Name | Type | Description |
|---|---|---|
videoStream |
VideoStream | The video stream. |
Returns: PeerConnection
Defined in: Generated/TypeScript/fm.liveswitch/PeerConnectionOffer.ts:134
▸ accept(videoStream: VideoStream, dataStream: DataStream): PeerConnection
Accepts the offer.
Parameters:
| Name | Type | Description |
|---|---|---|
videoStream |
VideoStream | The video stream. |
dataStream |
DataStream | The data stream. |
Returns: PeerConnection
Defined in: Generated/TypeScript/fm.liveswitch/PeerConnectionOffer.ts:142
addOnCancel
▸ addOnCancel(value: IAction0): void
Adds a handler that is raised when the offer is withdrawn.
Parameters:
| Name | Type |
|---|---|
value |
IAction0 |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/PeerConnectionOffer.ts:179
fmliveswitchPeerConnectionOfferInit
▸ PrivatefmliveswitchPeerConnectionOfferInit(): void
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/PeerConnectionOffer.ts:41
getChannel
▸ getChannel(): Channel
Gets the channel.
Returns: Channel
Defined in: Generated/TypeScript/fm.liveswitch/PeerConnectionOffer.ts:191
getConnectionTag
▸ getConnectionTag(): string
Gets the connection tag.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/PeerConnectionOffer.ts:203
getHasAudio
▸ getHasAudio(): boolean
Gets a value indicating whether the offer includes an audio description.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/PeerConnectionOffer.ts:224
getHasData
▸ getHasData(): boolean
Gets a value indicating whether the offer includes a data description.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/PeerConnectionOffer.ts:237
getHasVideo
▸ getHasVideo(): boolean
Gets a value indicating whether the offer includes a video description.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/PeerConnectionOffer.ts:250
getOffer
▸ getOffer(): SessionDescription
Gets the offer.
Returns: SessionDescription
Defined in: Generated/TypeScript/fm.liveswitch/PeerConnectionOffer.ts:262
getRemoteClientInfo
▸ getRemoteClientInfo(): ClientInfo
Gets the remote client information.
Returns: ClientInfo
Defined in: Generated/TypeScript/fm.liveswitch/PeerConnectionOffer.ts:274
getRemoteClosed
▸ getRemoteClosed(): boolean
Gets a value indicating whether the connection was closed by the remote host.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/PeerConnectionOffer.ts:287
getRemoteConnectionId
▸ getRemoteConnectionId(): string
Gets the remote connection identifier.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/PeerConnectionOffer.ts:299
getRemoteFailed
▸ getRemoteFailed(): boolean
Gets a value indicating whether the connection was failed by the remote host.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/PeerConnectionOffer.ts:312
getTypeString
▸ getTypeString(): string
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/PeerConnectionOffer.ts:9
reject
▸ reject(): Future<Object>
Rejects this instance.
Returns: Future<Object>
Defined in: Generated/TypeScript/fm.liveswitch/PeerConnectionOffer.ts:351
removeOnCancel
▸ removeOnCancel(value: IAction0): void
Removes a handler that is raised when the offer is withdrawn.
Parameters:
| Name | Type |
|---|---|
value |
IAction0 |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/PeerConnectionOffer.ts:363