FMLiveSwitchPeerConnectionOffer Class Reference

A peer connection offer. More...

Instance Methods

(FMLiveSwitchPeerConnection *) - acceptWithAudioStream:
 Accepts the offer. More...
 
(FMLiveSwitchPeerConnection *) - acceptWithAudioStream:dataStream:
 Accepts the offer. More...
 
(FMLiveSwitchPeerConnection *) - acceptWithAudioStream:videoStream:
 Accepts the offer. More...
 
(FMLiveSwitchPeerConnection *) - acceptWithAudioStream:videoStream:dataStream:
 Accepts the offer. More...
 
(FMLiveSwitchPeerConnection *) - acceptWithDataStream:
 Accepts the offer. More...
 
(FMLiveSwitchPeerConnection *) - acceptWithVideoStream:
 Accepts the offer. More...
 
(FMLiveSwitchPeerConnection *) - acceptWithVideoStream:dataStream:
 Accepts the offer. More...
 
(void) - addOnCancel:
 Adds a handler that is raised when the offer is withdrawn. More...
 
(FMLiveSwitchChannel *) - channel
 Gets the channel. More...
 
(NSString *) - connectionTag
 Gets the connection tag. More...
 
(bool) - hasAudio
 Gets a value indicating whether the offer includes an audio description. More...
 
(bool) - hasData
 Gets a value indicating whether the offer includes a data description. More...
 
(bool) - hasVideo
 Gets a value indicating whether the offer includes a video description. More...
 
(FMLiveSwitchSessionDescription *) - offer
 Gets the offer. More...
 
(FMLiveSwitchFuture< id > *) - reject
 Rejects this instance. More...
 
(FMLiveSwitchClientInfo *) - remoteClientInfo
 Gets the remote client information. More...
 
(bool) - remoteClosed
 Gets a value indicating whether the connection was closed by the remote host. More...
 
(NSString *) - remoteConnectionId
 Gets the remote connection identifier. More...
 
(bool) - remoteFailed
 Gets a value indicating whether the connection was failed by the remote host. More...
 
(void) - removeOnCancel:
 Removes a handler that is raised when the offer is withdrawn. More...
 

Detailed Description

A peer connection offer.

Method Documentation

◆ acceptWithAudioStream:

- (FMLiveSwitchPeerConnection*) acceptWithAudioStream: (FMLiveSwitchAudioStream *)  audioStream

Accepts the offer.

Parameters
audioStreamThe audio stream.

◆ acceptWithAudioStream:dataStream:

Accepts the offer.

Parameters
audioStreamThe audio stream.
dataStreamThe data stream.

◆ acceptWithAudioStream:videoStream:

Accepts the offer.

Parameters
audioStreamThe audio stream.
videoStreamThe video stream.

◆ acceptWithAudioStream:videoStream:dataStream:

- (FMLiveSwitchPeerConnection*) acceptWithAudioStream: (FMLiveSwitchAudioStream *)  audioStream
videoStream: (FMLiveSwitchVideoStream *)  videoStream
dataStream: (FMLiveSwitchDataStream *)  dataStream 

Accepts the offer.

Parameters
audioStreamThe audio stream.
videoStreamThe video stream.
dataStreamThe data stream.

◆ acceptWithDataStream:

- (FMLiveSwitchPeerConnection*) acceptWithDataStream: (FMLiveSwitchDataStream *)  dataStream

Accepts the offer.

Parameters
dataStreamThe data stream.

◆ acceptWithVideoStream:

- (FMLiveSwitchPeerConnection*) acceptWithVideoStream: (FMLiveSwitchVideoStream *)  videoStream

Accepts the offer.

Parameters
videoStreamThe video stream.

◆ acceptWithVideoStream:dataStream:

Accepts the offer.

Parameters
videoStreamThe video stream.
dataStreamThe data stream.

◆ addOnCancel:

- (void) addOnCancel: (FMLiveSwitchAction0 *)  value

Adds a handler that is raised when the offer is withdrawn.

◆ channel

- (FMLiveSwitchChannel*) channel

Gets the channel.

◆ connectionTag

- (NSString*) connectionTag

Gets the connection tag.

◆ hasAudio

- (bool) hasAudio

Gets a value indicating whether the offer includes an audio description.

◆ hasData

- (bool) hasData

Gets a value indicating whether the offer includes a data description.

◆ hasVideo

- (bool) hasVideo

Gets a value indicating whether the offer includes a video description.

◆ offer

Gets the offer.

◆ reject

- (FMLiveSwitchFuture<id>*) reject

Rejects this instance.

◆ remoteClientInfo

- (FMLiveSwitchClientInfo*) remoteClientInfo

Gets the remote client information.

◆ remoteClosed

- (bool) remoteClosed

Gets a value indicating whether the connection was closed by the remote host.

◆ remoteConnectionId

- (NSString*) remoteConnectionId

Gets the remote connection identifier.

◆ remoteFailed

- (bool) remoteFailed

Gets a value indicating whether the connection was failed by the remote host.

◆ removeOnCancel:

- (void) removeOnCancel: (FMLiveSwitchAction0 *)  value

Removes a handler that is raised when the offer is withdrawn.