FMLiveSwitchMediaStream Class Reference

A media stream. More...

Instance Methods

(FMLiveSwitchStreamDirection) - absoluteSenderTimeDirection
 Gets the current direction for the RTP Header Extension for Absolute Sender Time. More...
 
(FMLiveSwitchStreamDirection) - absoluteSenderTimeLocalDirection
 Gets the current local direction for the RTP Header Extension for Absolute Sender Time. More...
 
(FMLiveSwitchStreamDirection) - absoluteSenderTimeRemoteDirection
 Gets the current remote direction for the RTP Header Extension for Absolute Sender Time. More...
 
(void) - addInput:
 Adds an input. More...
 
(void) - addInputs:
 Adds some inputs. More...
 
(void) - addOnDiscardBitrateNotification:
 Adds a handler that is raised when a bitrate notification is discarded due to policy restrictions or lack of support by the remote endpoint. More...
 
(FMLiveSwitchBitrateNotification *) - addOnDiscardBitrateNotificationWithBlock
 Adds a handler that is raised when a bitrate notification is discarded due to policy restrictions or lack of support by the remote endpoint. More...
 
(void) - addOnDiscardBitrateNotificationWithBlock:
 Adds a handler that is raised when a bitrate notification is discarded due to policy restrictions or lack of support by the remote endpoint. More...
 
(void) - addOnDiscardBitrateRequest:
 Adds a handler that is raised when a bitrate notification message is discarded by the internal in-band messaging mechanism because the peer does not support bitrate notifications. More...
 
(FMLiveSwitchBitrateRequest *) - addOnDiscardBitrateRequestWithBlock
 Adds a handler that is raised when a bitrate notification message is discarded by the internal in-band messaging mechanism because the peer does not support bitrate notifications. More...
 
(void) - addOnDiscardBitrateRequestWithBlock:
 Adds a handler that is raised when a bitrate notification message is discarded by the internal in-band messaging mechanism because the peer does not support bitrate notifications. More...
 
(void) - addOnDiscardOutboundControlFrame:
 Adds a handler that is raised when an outbound control frame is discarded due to policy restrictions or lack of support by the remote endpoint. More...
 
(FMLiveSwitchMediaControlFrame *) - addOnDiscardOutboundControlFrameWithBlock
 Adds a handler that is raised when an outbound control frame is discarded due to policy restrictions or lack of support by the remote endpoint. More...
 
(void) - addOnDiscardOutboundControlFrameWithBlock:
 Adds a handler that is raised when an outbound control frame is discarded due to policy restrictions or lack of support by the remote endpoint. More...
 
(void) - addOnMasterSynchronizeContextReady:
 Adds a handler that is raised by master streams when the synchronize context is ready. More...
 
(FMLiveSwitchSynchronizeContext *) - addOnMasterSynchronizeContextReadyWithBlock
 Adds a handler that is raised by master streams when the synchronize context is ready. More...
 
(void) - addOnMasterSynchronizeContextReadyWithBlock:
 Adds a handler that is raised by master streams when the synchronize context is ready. More...
 
(void) - addOnPausedChange:
 Adds a handler that is raised when the Paused property changes state. More...
 
(void) - addOnProcessControlFrameResponses:
 Adds a handler that is raised when control frame responses are processed. More...
 
(NSMutableArray *) - addOnProcessControlFrameResponsesWithBlock
 Adds a handler that is raised when control frame responses are processed. More...
 
(void) - addOnProcessControlFrameResponsesWithBlock:
 Adds a handler that is raised when control frame responses are processed. More...
 
(void) - addOnProcessControlFrames:
 Adds a handler that is raised when control frames are processed. More...
 
(NSMutableArray *) - addOnProcessControlFramesWithBlock
 Adds a handler that is raised when control frames are processed. More...
 
(void) - addOnProcessControlFramesWithBlock:
 Adds a handler that is raised when control frames are processed. More...
 
(void) - addOnProcessedFrame:
 Adds a handler that is raised when a frame has been processed. More...
 
(TFrame) - addOnProcessedFrameWithBlock
 Adds a handler that is raised when a frame has been processed. More...
 
(void) - addOnProcessedFrameWithBlock:
 Adds a handler that is raised when a frame has been processed. More...
 
(void) - addOnProcessFrame:
 Adds a handler that is raised when a frame is being processed. More...
 
(TFrame) - addOnProcessFrameWithBlock
 Adds a handler that is raised when a frame is being processed. More...
 
(void) - addOnProcessFrameWithBlock:
 Adds a handler that is raised when a frame is being processed. More...
 
(void) - addOnRaiseControlFrameResponses:
 Adds a handler that is raised when control frame responses are raised. More...
 
(NSMutableArray *) - addOnRaiseControlFrameResponsesWithBlock
 Adds a handler that is raised when control frame responses are raised. More...
 
(void) - addOnRaiseControlFrameResponsesWithBlock:
 Adds a handler that is raised when control frame responses are raised. More...
 
(void) - addOnRaiseControlFrames:
 Adds a handler that is raised when control frames are raised. More...
 
(NSMutableArray *) - addOnRaiseControlFramesWithBlock
 Adds a handler that is raised when control frames are raised. More...
 
(void) - addOnRaiseControlFramesWithBlock:
 Adds a handler that is raised when control frames are raised. More...
 
(void) - addOnRaisedFrame:
 Adds a handler that is raised when a frame has been raised. More...
 
(TFrame) - addOnRaisedFrameWithBlock
 Adds a handler that is raised when a frame has been raised. More...
 
(void) - addOnRaisedFrameWithBlock:
 Adds a handler that is raised when a frame has been raised. More...
 
(void) - addOnRaiseFrame:
 Adds a handler that is raised when a frame is being raised. More...
 
(TFrame) - addOnRaiseFrameWithBlock
 Adds a handler that is raised when a frame is being raised. More...
 
(void) - addOnRaiseFrameWithBlock:
 Adds a handler that is raised when a frame is being raised. More...
 
(void) - addOnReceiveFrame:
 Adds a handler that is raised when a frame is received. More...
 
(TFrame) - addOnReceiveFrameWithBlock
 Adds a handler that is raised when a frame is received. More...
 
(void) - addOnReceiveFrameWithBlock:
 Adds a handler that is raised when a frame is received. More...
 
(void) - addOnSendFrame:
 Adds a handler that is raised when a frame is sent. More...
 
(TFrame) - addOnSendFrameWithBlock
 Adds a handler that is raised when a frame is sent. More...
 
(void) - addOnSendFrameWithBlock:
 Adds a handler that is raised when a frame is sent. More...
 
(void) - addOutput:
 Adds an output. More...
 
(void) - addOutputs:
 Adds some outputs. More...
 
(FMLiveSwitchBandwidthAdaptationPolicy) - bandwidthAdaptationPolicy
 Gets bandwidth adapation policy for this stream. More...
 
(bool) - ccmFirEnabled
 Gets whether CCM FIRs are allowed. More...
 
(FMLiveSwitchCcmFirPolicy) - ccmFirPolicy
 Gets the CCM FIR Policy. More...
 
(bool) - ccmLrrEnabled
 Gets whether CCM LRRs are allowed. More...
 
(FMLiveSwitchCcmLrrPolicy) - ccmLrrPolicy
 Gets the CCM LRR Policy. More...
 
(bool) - ccmTmmbnEnabled
 Gets whether CCM TMMBNs are allowed. More...
 
(FMLiveSwitchCcmTmmbnPolicy) - ccmTmmbnPolicy
 Gets the CCM TMMBR Policy. More...
 
(bool) - ccmTmmbrEnabled
 Gets whether CCM TMMBRs are allowed. More...
 
(FMLiveSwitchCcmTmmbrPolicy) - ccmTmmbrPolicy
 Gets the CCM TMMBR Policy. More...
 
(FMLiveSwitchFuture< id > *) - changeInputFormat:
 Changes the current input format (switches codecs). More...
 
(NSString *) - content
 Gets the content descriptor. More...
 
(FMLiveSwitchTransportInfo *) - controlTransportInfo
 Gets control transport information. More...
 
(TFormat) - createFormatWithAttribute:formatParametersAttribute:
 Creates a format. More...
 
(TFormat) - createFormatWithName:clockRate:parameters:payloadType:
 Creates a format. More...
 
(TIInputCollection) - createInputCollectionWithOutput:
 Creates an input collection. More...
 
(TFormatCollection) - createMediaFormatCollection
 Creates a media format collection. More...
 
(TIOutputCollection) - createOutputCollectionWithInput:
 Creates an output collection. More...
 
(TFormat) - createRedFormat
 Creates a RED format. More...
 
(TFormat) - createUlpFecFormat
 Creates a ulpfec format. More...
 
(long long) - defaultLocalSynchronizationSource
 Gets default local synchronization source (SSRC) associated with a local sender. More...
 
(bool) - destroy
 Destroys this instance. More...
 
(bool) - disableAutomaticReports
 Gets a value indicating whether to disable automatic RTCP sender/receiver reports. More...
 
(NSMutableArray *) - disabledInputFormats
 Gets the disabled input formats. More...
 
(FMLiveSwitchFuture< id > *) - disableInputFormat:
 Disables an input format. More...
 
(FMLiveSwitchFuture< id > *) - enableInputFormat:
 Enables an input format. More...
 
(NSMutableArray *) - formatArrayFromListWithFormatList:
 Creates a format array from a format list. More...
 
(int) - getCcmSequenceNumber
 Gets the FIR sequence number. More...
 
(bool) - getInputSourceMutedWithInput:
 Gets whether an input source is muted. More...
 
(bool) - getInputSourceMutedWithInputs:
 Gets whether an input source is muted. More...
 
(NSString *) - getLocalRtpStreamIdWithLocalSynchronizationSource:
 Gets the local RTP stream identifier for a given local synchronization source. More...
 
(long long) - getLocalSynchronizationSourceWithRtpStreamId:
 Gets the local synchronization source for a given local RTP stream identifier. More...
 
(bool) - getOutputSinkMutedWithOutput:
 Gets whether an output source is muted. More...
 
(bool) - getOutputSinkMutedWithOutputs:
 Gets whether an output sink is muted. More...
 
(long long) - getPipelineSystemDelayWithOutputFormat:
 Gets the total pipeline system delay in ticks for a given output format. More...
 
(NSString *) - getRemoteRtpStreamIdWithRemoteSynchronizationSource:
 Gets the remote RTP stream identifier for a given remote synchronization source. More...
 
(long long) - getRemoteSynchronizationSourceWithRtpStreamId:
 Gets the remote synchronization source for a given remote RTP stream identifier. More...
 
(void) - incrementCcmSequenceNumber
 Increments the FIR sequence number. More...
 
(instancetype) - initWithType:jitterConfig:
 Initializes a new instance of the FMLiveSwitchMediaStream`15 class. More...
 
(bool) - injectionAllowed
 Gets whether at least one frame has been successfully processed. More...
 
(TIOutput) - input
 Gets the input. More...
 
(NSMutableArray *) - inputArrayFromListWithInputList:
 Creates an input array from an input list. More...
 
(bool) - inputDeactivated
 Gets whether input is deactivated. More...
 
(TFormat) - inputFormat
 Gets the current input format. More...
 
(NSMutableArray *) - inputFormats
 Gets the available input formats. More...
 
(int) - inputMaxOutputBitrate
 Gets the sum of the bitrates from FMLiveSwitchMediaStream`15inputMaxOutputEncodings. More...
 
(NSMutableArray *) - inputMaxOutputEncodings
 Gets the inputs' maximum allowed output encodings. More...
 
(int) - inputMinOutputBitrate
 Gets the sum of the bitrates from FMLiveSwitchMediaStream`15inputMinOutputEncodings. More...
 
(NSMutableArray *) - inputMinOutputEncodings
 Gets the inputs' minimum allowed output encodings. More...
 
(bool) - inputMuted
 Gets whether the input track is muted. More...
 
(NSString *) - inputRtpStreamId
 Gets null to satisfy interface requirements. More...
 
(NSMutableArray *) - inputs
 Gets the inputs. More...
 
(bool) - inputSynchronizationDisabled
 Gets whether input synchronization is disabled. More...
 
(long long) - inputSynchronizationSource
 Gets -1 to satisfy interface requirements. More...
 
(NSMutableArray *) - inputSynchronizationSources
 Gets the input synchronization sources. More...
 
(int) - inputTargetOutputBitrate
 Gets the sum of the bitrates from FMLiveSwitchMediaStream`15inputTargetOutputEncodings. More...
 
(NSMutableArray *) - inputTargetOutputEncodings
 Gets the inputs' target output encodings. More...
 
(FMLiveSwitchJitterConfig *) - jitterConfig
 Gets the jitter configuration. More...
 
(bool) - legacyReceiver
 Gets whether to use legacy receiver processing. More...
 
(NSString *) - localDescriptionMediaId
 Gets the local description media identifier. More...
 
(NSString *) - localDescriptionTrackId
 Gets the local description track identifier. More...
 
(FMLiveSwitchLocalMedia *) - localMedia
 Gets the local media, if one was specified. More...
 
(TTrack) - localTrack
 Gets the local track from this media. More...
 
(int) - maxInputBitrate
 Gets the maximum allowed input bitrate, in kbps. More...
 
(FMLiveSwitchEncodingInfo *) - maxInputEncoding
 Gets the max input encoding. More...
 
(int) - maxOutputBitrate
 Gets the maximum allowed output bitrate, in kbps. More...
 
(FMLiveSwitchEncodingInfo *) - maxOutputEncoding
 Gets the max output encoding. More...
 
(int) - maxReceiveBitrate
 Gets the maximum desired receive bitrate, in kbps. More...
 
(int) - minInputBitrate
 Gets the minimum allowed input bitrate, in kbps. More...
 
(FMLiveSwitchEncodingInfo *) - minInputEncoding
 Gets the min input encoding. More...
 
(int) - minOutputBitrate
 Gets the minimum allowed output bitrate, in kbps. More...
 
(FMLiveSwitchEncodingInfo *) - minOutputEncoding
 Gets the min output encoding. More...
 
(bool) - multiplexed
 Gets a value indicating whether Rtp and Rtcp components for this stream are multiplexed on the same port. More...
 
(bool) - multiplexingSupported
 Gets a value indicating whether so far negotiation with the peer indicates that Rtp and Rtcp component multiplexing on the same port is supported. More...
 
(FMLiveSwitchNackConfig *) - nackConfig
 Gets Nack config. More...
 
(bool) - nackEnabled
 Gets whether NACKs are allowed. More...
 
(bool) - nackPliEnabled
 Gets whether NACK PLIs are allowed. More...
 
(FMLiveSwitchNackPliPolicy) - nackPliPolicy
 Gets the NACK PLI Policy. More...
 
(FMLiveSwitchNackPolicy) - nackPolicy
 Gets the NACK Policy. More...
 
(TIInput) - output
 Gets the output. More...
 
(NSMutableArray *) - outputArrayFromListWithOutputList:
 Creates an output array from an output list. More...
 
(bool) - outputDeactivated
 Gets whether output is deactivated. More...
 
(TFormat) - outputFormat
 Gets the output format. More...
 
(int) - outputMaxInputBitrate
 Gets the sum of the bitrates from FMLiveSwitchMediaStream`15outputMaxInputEncodings. More...
 
(NSMutableArray *) - outputMaxInputEncodings
 Gets the outputs' maximum allowed input encodings. More...
 
(int) - outputMinInputBitrate
 Gets the sum of the bitrates from FMLiveSwitchMediaStream`15outputMinInputEncodings. More...
 
(NSMutableArray *) - outputMinInputEncodings
 Gets the outputs' minimum allowed input encodings. More...
 
(bool) - outputMuted
 Gets whether the output track is muted. More...
 
(NSString *) - outputRtpStreamId
 Gets null to satisfy interface requirements. More...
 
(NSMutableArray *) - outputs
 Gets the outputs. More...
 
(bool) - outputSynchronizable
 Gets whether output is synchronizable. More...
 
(bool) - outputSynchronizationDisabled
 Gets whether output synchronization is disabled. More...
 
(long long) - outputSynchronizationSource
 Gets -1 to satisfy interface requirements. More...
 
(NSMutableArray *) - outputSynchronizationSources
 Gets the output synchronization sources. More...
 
(bool) - overConstrained
 Gets whether this stream is over-constrained. More...
 
(bool) - overConstrainedBitrate
 Gets whether the stream bitrate is over-constrained. More...
 
(bool) - overConstrainedInput
 Gets whether the input is over-contrained. More...
 
(bool) - overConstrainedInputBitrate
 Gets whether the minimum allowed input bitrate exceeds the maximum allowed input bitrate. More...
 
(bool) - overConstrainedOutput
 Gets whether the output is over-constrained. More...
 
(bool) - overConstrainedOutputBitrate
 Gets whether the minimum allowed output bitrate exceeds the maximum allowed output bitrate. More...
 
(bool) - paused
 Gets a value indicating whether this stream is paused. More...
 
(bool) - persistent
 Gets a value indicating whether this instance is persistent. More...
 
(NSString *) - pipelineJson
 Gets the pipeline JSON with this as the central point. More...
 
(NSString *) - pipelineJsonFromInput
 Gets the pipeline JSON from an input. More...
 
(NSString *) - pipelineJsonFromOutput
 Gets the pipeline JSON from an output. More...
 
(void) - populateInfo:
 Populates the media stream info. More...
 
(void) - processControlFrame:
 Processes a control frame. More...
 
(void) - processControlFrameResponse:
 Processes a control frame response. More...
 
(void) - processControlFrameResponses:
 Processes control frame responses. More...
 
(void) - processControlFrames:
 Processes control frames. More...
 
(bool) - processFrame:
 Processes a frame. More...
 
(FMLiveSwitchProcessFramePolicy) - processFramePolicy
 Gets the ProcessFramePolicy for this media input. More...
 
(void) - processSdpContentAttribute:isLocalDescription:
 Processes an SDP content attribute. More...
 
(FMLiveSwitchError *) - processSdpMediaDescriptionFromInputWithMediaDescription:isOffer:isLocalDescription:
 Processes a local SDP media description from an input. More...
 
(FMLiveSwitchError *) - processSdpMediaDescriptionFromOutputWithMediaDescription:isOffer:isLocalDescription:
 Processes a local SDP media description from an output. More...
 
(void) - processSinkStatsFromInputWithSinkStats:
 Processes sink stats from an input. More...
 
(void) - processSourceStatsFromOutputWithSourceStats:
 Processes source stats from an output. More...
 
(void) - processTrackStatsFromInputWithTrackStats:
 Processes stats from an input. More...
 
(void) - processTrackStatsFromOutputWithTrackStats:
 Processes stats from an output. More...
 
(bool) - raiseBitrateNotification:
 Raises a bitrate notification to the remote track. More...
 
(bool) - raiseBitrateRequest:
 Raises a bitrate request to the local track. More...
 
(void) - raiseFrame:
 Raises a frame. More...
 
(FMLiveSwitchRedFecConfig *) - redFecConfig
 Gets Fec Config. More...
 
(bool) - redFecEnabled
 Gets True if Red Fec is negotiated. More...
 
(FMLiveSwitchRedFecPolicy) - redFecPolicy
 Gets the Fec Policy. More...
 
(bool) - rembEnabled
 Gets True if goog-remb is negotiated. More...
 
(FMLiveSwitchRembPolicy) - rembPolicy
 Gets the goog-remb policy. More...
 
(NSString *) - remoteDescriptionMediaId
 Gets the remote description media identifier. More...
 
(NSString *) - remoteDescriptionTrackId
 Gets the remote description track identifier. More...
 
(FMLiveSwitchEncodingInfo *) - remoteEncoding
 Gets the remote encoding. More...
 
(FMLiveSwitchRemoteMedia *) - remoteMedia
 Gets the remote media, if one was specified. More...
 
(TTrack) - remoteTrack
 Gets the remote track, if one was specified. More...
 
(bool) - removeInput:
 Removes an input. More...
 
(void) - removeInputs
 Removes all inputs. More...
 
(void) - removeInputs:
 Removes some inputs. More...
 
(void) - removeOnDiscardBitrateNotification:
 Removes a handler that is raised when a bitrate notification is discarded due to policy restrictions or lack of support by the remote endpoint. More...
 
(void) - removeOnDiscardBitrateRequest:
 Removes a handler that is raised when a bitrate notification message is discarded by the internal in-band messaging mechanism because the peer does not support bitrate notifications. More...
 
(void) - removeOnDiscardOutboundControlFrame:
 Removes a handler that is raised when an outbound control frame is discarded due to policy restrictions or lack of support by the remote endpoint. More...
 
(void) - removeOnMasterSynchronizeContextReady:
 Removes a handler that is raised by master streams when the synchronize context is ready. More...
 
(void) - removeOnPausedChange:
 Removes a handler that is raised when the Paused property changes state. More...
 
(void) - removeOnProcessControlFrameResponses:
 Removes a handler that is raised when control frame responses are processed. More...
 
(void) - removeOnProcessControlFrames:
 Removes a handler that is raised when control frames are processed. More...
 
(void) - removeOnProcessedFrame:
 Removes a handler that is raised when a frame has been processed. More...
 
(void) - removeOnProcessFrame:
 Removes a handler that is raised when a frame is being processed. More...
 
(void) - removeOnRaiseControlFrameResponses:
 Removes a handler that is raised when control frame responses are raised. More...
 
(void) - removeOnRaiseControlFrames:
 Removes a handler that is raised when control frames are raised. More...
 
(void) - removeOnRaisedFrame:
 Removes a handler that is raised when a frame has been raised. More...
 
(void) - removeOnRaiseFrame:
 Removes a handler that is raised when a frame is being raised. More...
 
(void) - removeOnReceiveFrame:
 Removes a handler that is raised when a frame is received. More...
 
(void) - removeOnSendFrame:
 Removes a handler that is raised when a frame is sent. More...
 
(bool) - removeOutput:
 Removes an output. More...
 
(void) - removeOutputs
 Removes all outputs. More...
 
(void) - removeOutputs:
 Removes some outputs. More...
 
(void) - setBandwidthAdaptationPolicy:
 Sets bandwidth adapation policy for this stream. More...
 
(void) - setCcmFirPolicy:
 Sets the CCM FIR Policy. More...
 
(void) - setCcmLrrPolicy:
 Sets the CCM LRR Policy. More...
 
(void) - setCcmTmmbnPolicy:
 Sets the CCM TMMBR Policy. More...
 
(void) - setCcmTmmbrPolicy:
 Sets the CCM TMMBR Policy. More...
 
(void) - setDisableAutomaticReports:
 Sets a value indicating whether to disable automatic RTCP sender/receiver reports. More...
 
(void) - setInputMuted:
 Sets whether the input track is muted. More...
 
(void) - setInputRtpStreamId:
 Sets null to satisfy interface requirements. More...
 
(void) - setInputSourceMutedWithInput:value:
 Sets whether an input source is muted. More...
 
(void) - setInputSourceMutedWithInputs:value:
 Sets whether an input source is muted. More...
 
(void) - setInputSynchronizationDisabled:
 Sets whether input synchronization is disabled. More...
 
(void) - setInputSynchronizationSource:
 Sets -1 to satisfy interface requirements. More...
 
(void) - setLegacyReceiver:
 Sets whether to use legacy receiver processing. More...
 
(void) - setLocalDescriptionMediaId:
 Sets the local description media identifier. More...
 
(void) - setLocalDescriptionTrackId:
 Sets the local description track identifier. More...
 
(void) - setLocalMedia:
 Sets the local media, if one was specified. More...
 
(void) - setLocalTrack:
 Sets the local track from this media. More...
 
(void) - setMaxReceiveBitrate:
 Sets the maximum desired receive bitrate, in kbps. More...
 
(void) - setNackPliPolicy:
 Sets the NACK PLI Policy. More...
 
(void) - setNackPolicy:
 Sets the NACK Policy. More...
 
(void) - setOutputFormat:
 Sets the output format. More...
 
(void) - setOutputMuted:
 Sets whether the output track is muted. More...
 
(void) - setOutputSinkMutedWithOutput:value:
 Sets whether an output source is muted. More...
 
(void) - setOutputSinkMutedWithOutputs:value:
 Sets whether an output sink is muted. More...
 
(void) - setOutputSynchronizationDisabled:
 Sets whether output synchronization is disabled. More...
 
(void) - setProcessFramePolicy:
 Sets the ProcessFramePolicy for this media input. More...
 
(void) - setRedFecPolicy:
 Sets the Fec Policy. More...
 
(void) - setRemoteEncoding:
 Sets the remote encoding. More...
 
(void) - setRemoteMedia:
 Sets the remote media, if one was specified. More...
 
(void) - setRemoteTrack:
 Sets the remote track, if one was specified. More...
 
(void) - setSimulcastMode:
 Sets the simulcast mode. More...
 
(void) - setSynchronizeContext:
 Sets the synchronize context. More...
 
(void) - setSystemDelay:
 Sets the system delay in ticks. More...
 
(FMLiveSwitchSimulcastMode) - simulcastMode
 Gets the simulcast mode. More...
 
(FMLiveSwitchSynchronizeContext *) - synchronizeContext
 Gets the synchronize context. More...
 
(NSMutableArray *) - synchronizers
 Gets all synchronizers in the stream output tracks. More...
 
(void) - synchronizeWithMaster:
 Initializes synchronization. More...
 
(long long) - systemDelay
 Gets the system delay in ticks. More...
 
(int) - targetOutputBitrate
 Gets the target output bitrate, in kbps. More...
 
(FMLiveSwitchEncodingInfo *) - targetOutputEncoding
 Gets the target output encoding. More...
 
(FMLiveSwitchTransportInfo *) - transportInfo
 Gets transport information. More...
 

Class Methods

(FMLiveSwitchMediaStream *) + mediaStreamWithType:jitterConfig:
 Initializes a new instance of the FMLiveSwitchMediaStream`15 class. More...
 

Protected Attributes

 __pad0__: FMLiveSwitchMediaStreamBase<FMLiveSwitchIMediaOutput
 
 FMLiveSwitchIOutput
 
 FMLiveSwitchIMediaInput
 
 FMLiveSwitchIInput
 
 FMLiveSwitchIMediaElement
 
 FMLiveSwitchIElement
 
 FMLiveSwitchIMediaStream
 
 FMLiveSwitchIStream
 

Detailed Description

A media stream.

Method Documentation

◆ absoluteSenderTimeDirection

- (FMLiveSwitchStreamDirection) absoluteSenderTimeDirection

Gets the current direction for the RTP Header Extension for Absolute Sender Time.

See https://webrtc.org/experiments/rtp-hdrext/abs-send-time/ . If the remote capability has not yet been receieved, only local requirements are taken into consideration.

◆ absoluteSenderTimeLocalDirection

- (FMLiveSwitchStreamDirection) absoluteSenderTimeLocalDirection

Gets the current local direction for the RTP Header Extension for Absolute Sender Time.

See https://webrtc.org/experiments/rtp-hdrext/abs-send-time/ . If the remote capability has not yet been received, only local requirements are taken into consideration.

◆ absoluteSenderTimeRemoteDirection

- (FMLiveSwitchStreamDirection) absoluteSenderTimeRemoteDirection

Gets the current remote direction for the RTP Header Extension for Absolute Sender Time.

See https://webrtc.org/experiments/rtp-hdrext/abs-send-time/ . If the remote capability has not yet been receieved, only local requirements are taken into consideration.

◆ addInput:

- (void) addInput: (TIOutput)  input

Adds an input.

Parameters
inputThe input.

◆ addInputs:

- (void) addInputs: (NSMutableArray *)  inputs

Adds some inputs.

Parameters
inputsThe inputs.

◆ addOnDiscardBitrateNotification:

- (void) addOnDiscardBitrateNotification: (FMLiveSwitchAction1< FMLiveSwitchBitrateNotification * > *)  value

Adds a handler that is raised when a bitrate notification is discarded due to policy restrictions or lack of support by the remote endpoint.

◆ addOnDiscardBitrateNotificationWithBlock

- (FMLiveSwitchBitrateNotification*) addOnDiscardBitrateNotificationWithBlock

Adds a handler that is raised when a bitrate notification is discarded due to policy restrictions or lack of support by the remote endpoint.

◆ addOnDiscardBitrateNotificationWithBlock:

- (void) addOnDiscardBitrateNotificationWithBlock: (void(^)(FMLiveSwitchBitrateNotification *))  valueBlock

Adds a handler that is raised when a bitrate notification is discarded due to policy restrictions or lack of support by the remote endpoint.

◆ addOnDiscardBitrateRequest:

- (void) addOnDiscardBitrateRequest: (FMLiveSwitchAction1< FMLiveSwitchBitrateRequest * > *)  value

Adds a handler that is raised when a bitrate notification message is discarded by the internal in-band messaging mechanism because the peer does not support bitrate notifications.


In this case, the bitrate notification needs to be transported out of band. LiveSwitch handles this internally by sending the message over Data Streams. No further action is required by application developers.
Use this event for for diagnostics and debugging.

◆ addOnDiscardBitrateRequestWithBlock

- (FMLiveSwitchBitrateRequest*) addOnDiscardBitrateRequestWithBlock

Adds a handler that is raised when a bitrate notification message is discarded by the internal in-band messaging mechanism because the peer does not support bitrate notifications.


In this case, the bitrate notification needs to be transported out of band. LiveSwitch handles this internally by sending the message over Data Streams. No further action is required by application developers.
Use this event for for diagnostics and debugging.

◆ addOnDiscardBitrateRequestWithBlock:

- (void) addOnDiscardBitrateRequestWithBlock: (void(^)(FMLiveSwitchBitrateRequest *))  valueBlock

Adds a handler that is raised when a bitrate notification message is discarded by the internal in-band messaging mechanism because the peer does not support bitrate notifications.


In this case, the bitrate notification needs to be transported out of band. LiveSwitch handles this internally by sending the message over Data Streams. No further action is required by application developers.
Use this event for for diagnostics and debugging.

◆ addOnDiscardOutboundControlFrame:

- (void) addOnDiscardOutboundControlFrame: (FMLiveSwitchAction1< FMLiveSwitchMediaControlFrame * > *)  value

Adds a handler that is raised when an outbound control frame is discarded due to policy restrictions or lack of support by the remote endpoint.

◆ addOnDiscardOutboundControlFrameWithBlock

- (FMLiveSwitchMediaControlFrame*) addOnDiscardOutboundControlFrameWithBlock

Adds a handler that is raised when an outbound control frame is discarded due to policy restrictions or lack of support by the remote endpoint.

◆ addOnDiscardOutboundControlFrameWithBlock:

- (void) addOnDiscardOutboundControlFrameWithBlock: (void(^)(FMLiveSwitchMediaControlFrame *))  valueBlock

Adds a handler that is raised when an outbound control frame is discarded due to policy restrictions or lack of support by the remote endpoint.

◆ addOnMasterSynchronizeContextReady:

- (void) addOnMasterSynchronizeContextReady: (FMLiveSwitchAction1< FMLiveSwitchSynchronizeContext * > *)  value

Adds a handler that is raised by master streams when the synchronize context is ready.

◆ addOnMasterSynchronizeContextReadyWithBlock

- (FMLiveSwitchSynchronizeContext*) addOnMasterSynchronizeContextReadyWithBlock

Adds a handler that is raised by master streams when the synchronize context is ready.

◆ addOnMasterSynchronizeContextReadyWithBlock:

- (void) addOnMasterSynchronizeContextReadyWithBlock: (void(^)(FMLiveSwitchSynchronizeContext *))  valueBlock

Adds a handler that is raised by master streams when the synchronize context is ready.

◆ addOnPausedChange:

- (void) addOnPausedChange: (FMLiveSwitchAction0 *)  value

Adds a handler that is raised when the Paused property changes state.

◆ addOnProcessControlFrameResponses:

- (void) addOnProcessControlFrameResponses: (FMLiveSwitchAction1< NSMutableArray * > *)  value

Adds a handler that is raised when control frame responses are processed.

◆ addOnProcessControlFrameResponsesWithBlock

- (NSMutableArray*) addOnProcessControlFrameResponsesWithBlock

Adds a handler that is raised when control frame responses are processed.

◆ addOnProcessControlFrameResponsesWithBlock:

- (void) addOnProcessControlFrameResponsesWithBlock: (void(^)(NSMutableArray *))  valueBlock

Adds a handler that is raised when control frame responses are processed.

◆ addOnProcessControlFrames:

- (void) addOnProcessControlFrames: (FMLiveSwitchAction1< NSMutableArray * > *)  value

Adds a handler that is raised when control frames are processed.

◆ addOnProcessControlFramesWithBlock

- (NSMutableArray*) addOnProcessControlFramesWithBlock

Adds a handler that is raised when control frames are processed.

◆ addOnProcessControlFramesWithBlock:

- (void) addOnProcessControlFramesWithBlock: (void(^)(NSMutableArray *))  valueBlock

Adds a handler that is raised when control frames are processed.

◆ addOnProcessedFrame:

- (void) addOnProcessedFrame: (FMLiveSwitchAction1< TFrame > *)  value

Adds a handler that is raised when a frame has been processed.

◆ addOnProcessedFrameWithBlock

- (TFrame) addOnProcessedFrameWithBlock

Adds a handler that is raised when a frame has been processed.

◆ addOnProcessedFrameWithBlock:

- (void) addOnProcessedFrameWithBlock: (void(^)(TFrame))  valueBlock

Adds a handler that is raised when a frame has been processed.

◆ addOnProcessFrame:

- (void) addOnProcessFrame: (FMLiveSwitchAction1< TFrame > *)  value

Adds a handler that is raised when a frame is being processed.

◆ addOnProcessFrameWithBlock

- (TFrame) addOnProcessFrameWithBlock

Adds a handler that is raised when a frame is being processed.

◆ addOnProcessFrameWithBlock:

- (void) addOnProcessFrameWithBlock: (void(^)(TFrame))  valueBlock

Adds a handler that is raised when a frame is being processed.

◆ addOnRaiseControlFrameResponses:

- (void) addOnRaiseControlFrameResponses: (FMLiveSwitchAction1< NSMutableArray * > *)  value

Adds a handler that is raised when control frame responses are raised.

◆ addOnRaiseControlFrameResponsesWithBlock

- (NSMutableArray*) addOnRaiseControlFrameResponsesWithBlock

Adds a handler that is raised when control frame responses are raised.

◆ addOnRaiseControlFrameResponsesWithBlock:

- (void) addOnRaiseControlFrameResponsesWithBlock: (void(^)(NSMutableArray *))  valueBlock

Adds a handler that is raised when control frame responses are raised.

◆ addOnRaiseControlFrames:

- (void) addOnRaiseControlFrames: (FMLiveSwitchAction1< NSMutableArray * > *)  value

Adds a handler that is raised when control frames are raised.

◆ addOnRaiseControlFramesWithBlock

- (NSMutableArray*) addOnRaiseControlFramesWithBlock

Adds a handler that is raised when control frames are raised.

◆ addOnRaiseControlFramesWithBlock:

- (void) addOnRaiseControlFramesWithBlock: (void(^)(NSMutableArray *))  valueBlock

Adds a handler that is raised when control frames are raised.

◆ addOnRaisedFrame:

- (void) addOnRaisedFrame: (FMLiveSwitchAction1< TFrame > *)  value

Adds a handler that is raised when a frame has been raised.

◆ addOnRaisedFrameWithBlock

- (TFrame) addOnRaisedFrameWithBlock

Adds a handler that is raised when a frame has been raised.

◆ addOnRaisedFrameWithBlock:

- (void) addOnRaisedFrameWithBlock: (void(^)(TFrame))  valueBlock

Adds a handler that is raised when a frame has been raised.

◆ addOnRaiseFrame:

- (void) addOnRaiseFrame: (FMLiveSwitchAction1< TFrame > *)  value

Adds a handler that is raised when a frame is being raised.

◆ addOnRaiseFrameWithBlock

- (TFrame) addOnRaiseFrameWithBlock

Adds a handler that is raised when a frame is being raised.

◆ addOnRaiseFrameWithBlock:

- (void) addOnRaiseFrameWithBlock: (void(^)(TFrame))  valueBlock

Adds a handler that is raised when a frame is being raised.

◆ addOnReceiveFrame:

- (void) addOnReceiveFrame: (FMLiveSwitchAction1< TFrame > *)  value

Adds a handler that is raised when a frame is received.

◆ addOnReceiveFrameWithBlock

- (TFrame) addOnReceiveFrameWithBlock

Adds a handler that is raised when a frame is received.

◆ addOnReceiveFrameWithBlock:

- (void) addOnReceiveFrameWithBlock: (void(^)(TFrame))  valueBlock

Adds a handler that is raised when a frame is received.

◆ addOnSendFrame:

- (void) addOnSendFrame: (FMLiveSwitchAction1< TFrame > *)  value

Adds a handler that is raised when a frame is sent.

◆ addOnSendFrameWithBlock

- (TFrame) addOnSendFrameWithBlock

Adds a handler that is raised when a frame is sent.

◆ addOnSendFrameWithBlock:

- (void) addOnSendFrameWithBlock: (void(^)(TFrame))  valueBlock

Adds a handler that is raised when a frame is sent.

◆ addOutput:

- (void) addOutput: (TIInput)  output

Adds an output.

Parameters
outputThe output.

◆ addOutputs:

- (void) addOutputs: (NSMutableArray *)  outputs

Adds some outputs.

Parameters
outputsThe outputs.

◆ bandwidthAdaptationPolicy

- (FMLiveSwitchBandwidthAdaptationPolicy) bandwidthAdaptationPolicy

Gets bandwidth adapation policy for this stream.

◆ ccmFirEnabled

- (bool) ccmFirEnabled

Gets whether CCM FIRs are allowed.

◆ ccmFirPolicy

- (FMLiveSwitchCcmFirPolicy) ccmFirPolicy

Gets the CCM FIR Policy.

◆ ccmLrrEnabled

- (bool) ccmLrrEnabled

Gets whether CCM LRRs are allowed.

◆ ccmLrrPolicy

- (FMLiveSwitchCcmLrrPolicy) ccmLrrPolicy

Gets the CCM LRR Policy.

◆ ccmTmmbnEnabled

- (bool) ccmTmmbnEnabled

Gets whether CCM TMMBNs are allowed.

◆ ccmTmmbnPolicy

- (FMLiveSwitchCcmTmmbnPolicy) ccmTmmbnPolicy

Gets the CCM TMMBR Policy.

◆ ccmTmmbrEnabled

- (bool) ccmTmmbrEnabled

Gets whether CCM TMMBRs are allowed.

◆ ccmTmmbrPolicy

- (FMLiveSwitchCcmTmmbrPolicy) ccmTmmbrPolicy

Gets the CCM TMMBR Policy.

◆ changeInputFormat:

- (FMLiveSwitchFuture<id>*) changeInputFormat: (TFormat)  inputFormat

Changes the current input format (switches codecs).

Parameters
inputFormatThe input format.

◆ content

- (NSString*) content

Gets the content descriptor.

◆ controlTransportInfo

- (FMLiveSwitchTransportInfo*) controlTransportInfo

Gets control transport information.

◆ createFormatWithAttribute:formatParametersAttribute:

- (TFormat) createFormatWithAttribute: (FMLiveSwitchSdpRtpMapAttribute *)  attribute
formatParametersAttribute: (FMLiveSwitchSdpFormatParametersAttribute *)  formatParametersAttribute 

Creates a format.

Parameters
attributeThe attribute.
formatParametersAttributeThe format parameters attribute.

Implemented in FMLiveSwitchVideoStream, and FMLiveSwitchAudioStream.

◆ createFormatWithName:clockRate:parameters:payloadType:

- (TFormat) createFormatWithName: (NSString *)  name
clockRate: (int)  clockRate
parameters: (NSString *)  parameters
payloadType: (int)  payloadType 

Creates a format.

Parameters
nameThe format name.
clockRateThe clock rate.
parametersThe parameters.
payloadTypeThe payload type.

Implemented in FMLiveSwitchVideoStream, and FMLiveSwitchAudioStream.

◆ createInputCollectionWithOutput:

- (TIInputCollection) createInputCollectionWithOutput: (TIOutput)  output

Creates an input collection.

Parameters
outputThe output.

◆ createMediaFormatCollection

- (TFormatCollection) createMediaFormatCollection

Creates a media format collection.

Implemented in FMLiveSwitchVideoStream, and FMLiveSwitchAudioStream.

◆ createOutputCollectionWithInput:

- (TIOutputCollection) createOutputCollectionWithInput: (TIInput)  input

Creates an output collection.

Parameters
inputThe input.

◆ createRedFormat

- (TFormat) createRedFormat

Creates a RED format.

Implemented in FMLiveSwitchVideoStream, and FMLiveSwitchAudioStream.

◆ createUlpFecFormat

- (TFormat) createUlpFecFormat

Creates a ulpfec format.

Implemented in FMLiveSwitchVideoStream, and FMLiveSwitchAudioStream.

◆ defaultLocalSynchronizationSource

- (long long) defaultLocalSynchronizationSource

Gets default local synchronization source (SSRC) associated with a local sender.

If the local SDP offer or answer has not yet been set on the Connection, this will return -1. Please wait till the local description has been set on the Connection before accessing this value.

◆ destroy

- (bool) destroy

Destroys this instance.

◆ disableAutomaticReports

- (bool) disableAutomaticReports

Gets a value indicating whether to disable automatic RTCP sender/receiver reports.

◆ disabledInputFormats

- (NSMutableArray*) disabledInputFormats

Gets the disabled input formats.

◆ disableInputFormat:

- (FMLiveSwitchFuture<id>*) disableInputFormat: (TFormat)  inputFormat

Disables an input format.

This will trigger a codec switch if disabling the current input format. This may disable the stream

Parameters
inputFormatThe input format.

◆ enableInputFormat:

- (FMLiveSwitchFuture<id>*) enableInputFormat: (TFormat)  inputFormat

Enables an input format.

This will NOT trigger a codec switch.

Parameters
inputFormatThe input format.

◆ formatArrayFromListWithFormatList:

- (NSMutableArray*) formatArrayFromListWithFormatList: (NSMutableArray< TFormat > *)  formatList

Creates a format array from a format list.

Parameters
formatListThe format list.

◆ getCcmSequenceNumber

- (int) getCcmSequenceNumber

Gets the FIR sequence number.

◆ getInputSourceMutedWithInput:

- (bool) getInputSourceMutedWithInput: (TIOutput)  input

Gets whether an input source is muted.

Parameters
inputThe input.

◆ getInputSourceMutedWithInputs:

- (bool) getInputSourceMutedWithInputs: (NSMutableArray *)  inputs

Gets whether an input source is muted.

Parameters
inputsThe inputs.

◆ getLocalRtpStreamIdWithLocalSynchronizationSource:

- (NSString*) getLocalRtpStreamIdWithLocalSynchronizationSource: (long long)  localSynchronizationSource

Gets the local RTP stream identifier for a given local synchronization source.

Parameters
localSynchronizationSourceThe local synchronization source.

◆ getLocalSynchronizationSourceWithRtpStreamId:

- (long long) getLocalSynchronizationSourceWithRtpStreamId: (NSString *)  rtpStreamId

Gets the local synchronization source for a given local RTP stream identifier.

Parameters
rtpStreamIdThe RTP stream identifier.

◆ getOutputSinkMutedWithOutput:

- (bool) getOutputSinkMutedWithOutput: (TIInput)  output

Gets whether an output source is muted.

Parameters
outputThe output.

◆ getOutputSinkMutedWithOutputs:

- (bool) getOutputSinkMutedWithOutputs: (NSMutableArray *)  outputs

Gets whether an output sink is muted.

Parameters
outputsThe outputs.

◆ getPipelineSystemDelayWithOutputFormat:

- (long long) getPipelineSystemDelayWithOutputFormat: (TFormat)  outputFormat

Gets the total pipeline system delay in ticks for a given output format.

Parameters
outputFormatThe output format.
Returns
The total pipeline system delay in ticks.

◆ getRemoteRtpStreamIdWithRemoteSynchronizationSource:

- (NSString*) getRemoteRtpStreamIdWithRemoteSynchronizationSource: (long long)  remoteSynchronizationSource

Gets the remote RTP stream identifier for a given remote synchronization source.

Parameters
remoteSynchronizationSourceThe remote synchronization source.

◆ getRemoteSynchronizationSourceWithRtpStreamId:

- (long long) getRemoteSynchronizationSourceWithRtpStreamId: (NSString *)  rtpStreamId

Gets the remote synchronization source for a given remote RTP stream identifier.

Parameters
rtpStreamIdThe RTP stream identifier.

◆ incrementCcmSequenceNumber

- (void) incrementCcmSequenceNumber

Increments the FIR sequence number.

◆ initWithType:jitterConfig:

- (instancetype) initWithType: (FMLiveSwitchStreamType)  type
jitterConfig: (FMLiveSwitchJitterConfig *)  jitterConfig 

Initializes a new instance of the FMLiveSwitchMediaStream`15 class.

Parameters
typeThe type.
jitterConfigThe jitter configuration.

◆ injectionAllowed

- (bool) injectionAllowed

Gets whether at least one frame has been successfully processed.

◆ input

- (TIOutput) input

Gets the input.

◆ inputArrayFromListWithInputList:

- (NSMutableArray*) inputArrayFromListWithInputList: (NSMutableArray< TIInput > *)  inputList

Creates an input array from an input list.

Parameters
inputListThe input list.

◆ inputDeactivated

- (bool) inputDeactivated

Gets whether input is deactivated.

Input is deactivated if the stream direction is unset, inactive, or recvonly.

◆ inputFormat

- (TFormat) inputFormat

Gets the current input format.

◆ inputFormats

- (NSMutableArray*) inputFormats

Gets the available input formats.

◆ inputMaxOutputBitrate

- (int) inputMaxOutputBitrate

Gets the sum of the bitrates from FMLiveSwitchMediaStream`15inputMaxOutputEncodings.

◆ inputMaxOutputEncodings

- (NSMutableArray*) inputMaxOutputEncodings

Gets the inputs' maximum allowed output encodings.

◆ inputMinOutputBitrate

- (int) inputMinOutputBitrate

Gets the sum of the bitrates from FMLiveSwitchMediaStream`15inputMinOutputEncodings.

◆ inputMinOutputEncodings

- (NSMutableArray*) inputMinOutputEncodings

Gets the inputs' minimum allowed output encodings.

◆ inputMuted

- (bool) inputMuted

Gets whether the input track is muted.

◆ inputRtpStreamId

- (NSString*) inputRtpStreamId

Gets null to satisfy interface requirements.

◆ inputs

- (NSMutableArray*) inputs

Gets the inputs.

◆ inputSynchronizationDisabled

- (bool) inputSynchronizationDisabled

Gets whether input synchronization is disabled.

◆ inputSynchronizationSource

- (long long) inputSynchronizationSource

Gets -1 to satisfy interface requirements.

◆ inputSynchronizationSources

- (NSMutableArray*) inputSynchronizationSources

Gets the input synchronization sources.

◆ inputTargetOutputBitrate

- (int) inputTargetOutputBitrate

Gets the sum of the bitrates from FMLiveSwitchMediaStream`15inputTargetOutputEncodings.

◆ inputTargetOutputEncodings

- (NSMutableArray*) inputTargetOutputEncodings

Gets the inputs' target output encodings.

◆ jitterConfig

- (FMLiveSwitchJitterConfig*) jitterConfig

Gets the jitter configuration.

◆ legacyReceiver

- (bool) legacyReceiver

Gets whether to use legacy receiver processing.

Legacy receiver processing uses a fixed-size jitter buffer and processes forward error correction pre-jitter.

◆ localDescriptionMediaId

- (NSString*) localDescriptionMediaId

Gets the local description media identifier.

If not set, defaults to the FMLiveSwitchMediaStream`15localMedia identifier, if one exists.

◆ localDescriptionTrackId

- (NSString*) localDescriptionTrackId

Gets the local description track identifier.

If not set, defaults to the FMLiveSwitchMediaStream`15localTrack identifier, if one exists.

◆ localMedia

- (FMLiveSwitchLocalMedia*) localMedia

Gets the local media, if one was specified.

◆ localTrack

- (TTrack) localTrack

Gets the local track from this media.

Returns null if there are no tracks.

◆ maxInputBitrate

- (int) maxInputBitrate

Gets the maximum allowed input bitrate, in kbps.

A value of -1 indicates unset (no maximum).

◆ maxInputEncoding

- (FMLiveSwitchEncodingInfo*) maxInputEncoding

Gets the max input encoding.

Implemented in FMLiveSwitchVideoStream.

◆ maxOutputBitrate

- (int) maxOutputBitrate

Gets the maximum allowed output bitrate, in kbps.

A value of -1 indicates unset (no maximum).

◆ maxOutputEncoding

- (FMLiveSwitchEncodingInfo*) maxOutputEncoding

Gets the max output encoding.

Implemented in FMLiveSwitchVideoStream.

◆ maxReceiveBitrate

- (int) maxReceiveBitrate

Gets the maximum desired receive bitrate, in kbps.

◆ mediaStreamWithType:jitterConfig:

+ (FMLiveSwitchMediaStream*) mediaStreamWithType: (FMLiveSwitchStreamType)  type
jitterConfig: (FMLiveSwitchJitterConfig *)  jitterConfig 

Initializes a new instance of the FMLiveSwitchMediaStream`15 class.

Parameters
typeThe type.
jitterConfigThe jitter configuration.

◆ minInputBitrate

- (int) minInputBitrate

Gets the minimum allowed input bitrate, in kbps.

A value of -1 indicates unset (no minimum).

◆ minInputEncoding

- (FMLiveSwitchEncodingInfo*) minInputEncoding

Gets the min input encoding.

Implemented in FMLiveSwitchVideoStream.

◆ minOutputBitrate

- (int) minOutputBitrate

Gets the minimum allowed output bitrate, in kbps.

A value of -1 indicates unset (no minimum).

◆ minOutputEncoding

- (FMLiveSwitchEncodingInfo*) minOutputEncoding

Gets the min output encoding.

Implemented in FMLiveSwitchVideoStream.

◆ multiplexed

- (bool) multiplexed

Gets a value indicating whether Rtp and Rtcp components for this stream are multiplexed on the same port.

◆ multiplexingSupported

- (bool) multiplexingSupported

Gets a value indicating whether so far negotiation with the peer indicates that Rtp and Rtcp component multiplexing on the same port is supported.

◆ nackConfig

- (FMLiveSwitchNackConfig*) nackConfig

Gets Nack config.

◆ nackEnabled

- (bool) nackEnabled

Gets whether NACKs are allowed.

◆ nackPliEnabled

- (bool) nackPliEnabled

Gets whether NACK PLIs are allowed.

◆ nackPliPolicy

- (FMLiveSwitchNackPliPolicy) nackPliPolicy

Gets the NACK PLI Policy.

◆ nackPolicy

- (FMLiveSwitchNackPolicy) nackPolicy

Gets the NACK Policy.

◆ output

- (TIInput) output

Gets the output.

◆ outputArrayFromListWithOutputList:

- (NSMutableArray*) outputArrayFromListWithOutputList: (NSMutableArray< TIOutput > *)  outputList

Creates an output array from an output list.

Parameters
outputListThe output list.

◆ outputDeactivated

- (bool) outputDeactivated

Gets whether output is deactivated.

Output is deactivated if the stream direction is unset, inactive, or sendonly.

◆ outputFormat

- (TFormat) outputFormat

Gets the output format.

◆ outputMaxInputBitrate

- (int) outputMaxInputBitrate

Gets the sum of the bitrates from FMLiveSwitchMediaStream`15outputMaxInputEncodings.

◆ outputMaxInputEncodings

- (NSMutableArray*) outputMaxInputEncodings

Gets the outputs' maximum allowed input encodings.

◆ outputMinInputBitrate

- (int) outputMinInputBitrate

Gets the sum of the bitrates from FMLiveSwitchMediaStream`15outputMinInputEncodings.

◆ outputMinInputEncodings

- (NSMutableArray*) outputMinInputEncodings

Gets the outputs' minimum allowed input encodings.

◆ outputMuted

- (bool) outputMuted

Gets whether the output track is muted.

◆ outputRtpStreamId

- (NSString*) outputRtpStreamId

Gets null to satisfy interface requirements.

◆ outputs

- (NSMutableArray*) outputs

Gets the outputs.

◆ outputSynchronizable

- (bool) outputSynchronizable

Gets whether output is synchronizable.

◆ outputSynchronizationDisabled

- (bool) outputSynchronizationDisabled

Gets whether output synchronization is disabled.

◆ outputSynchronizationSource

- (long long) outputSynchronizationSource

Gets -1 to satisfy interface requirements.

◆ outputSynchronizationSources

- (NSMutableArray*) outputSynchronizationSources

Gets the output synchronization sources.

◆ overConstrained

- (bool) overConstrained

Gets whether this stream is over-constrained.

A stream is over-constrained if either it's input or output is over-constrained.

◆ overConstrainedBitrate

- (bool) overConstrainedBitrate

Gets whether the stream bitrate is over-constrained.

A stream bitrate is over-constrained if the input bitrate or output bitrate is over-constrained.

◆ overConstrainedInput

- (bool) overConstrainedInput

Gets whether the input is over-contrained.

An input is over-constrained if it's input bitrate is over-contrained.

Implemented in FMLiveSwitchVideoStream.

◆ overConstrainedInputBitrate

- (bool) overConstrainedInputBitrate

Gets whether the minimum allowed input bitrate exceeds the maximum allowed input bitrate.

◆ overConstrainedOutput

- (bool) overConstrainedOutput

Gets whether the output is over-constrained.

An output is over-constrained if it's output bitrate is over-contrained.

Implemented in FMLiveSwitchVideoStream.

◆ overConstrainedOutputBitrate

- (bool) overConstrainedOutputBitrate

Gets whether the minimum allowed output bitrate exceeds the maximum allowed output bitrate.

◆ paused

- (bool) paused

Gets a value indicating whether this stream is paused.

◆ persistent

- (bool) persistent

Gets a value indicating whether this instance is persistent.

Always returns false.

◆ pipelineJson

- (NSString*) pipelineJson

Gets the pipeline JSON with this as the central point.

◆ pipelineJsonFromInput

- (NSString*) pipelineJsonFromInput

Gets the pipeline JSON from an input.

◆ pipelineJsonFromOutput

- (NSString*) pipelineJsonFromOutput

Gets the pipeline JSON from an output.

◆ populateInfo:

- (void) populateInfo: (FMLiveSwitchMediaStreamInfo *)  info

Populates the media stream info.

Parameters
info

◆ processControlFrame:

- (void) processControlFrame: (FMLiveSwitchMediaControlFrame *)  controlFrame

Processes a control frame.

Parameters
controlFrameThe control frame.

◆ processControlFrameResponse:

- (void) processControlFrameResponse: (FMLiveSwitchMediaControlFrame *)  controlFrameResponse

Processes a control frame response.

Parameters
controlFrameResponseThe control frame response.

◆ processControlFrameResponses:

- (void) processControlFrameResponses: (NSMutableArray *)  controlFrameResponses

Processes control frame responses.

Parameters
controlFrameResponsesThe control frame responses.

◆ processControlFrames:

- (void) processControlFrames: (NSMutableArray *)  controlFrames

Processes control frames.

Parameters
controlFramesThe control frames.

◆ processFrame:

- (bool) processFrame: (TFrame)  frame

Processes a frame.

Parameters
frameThe frame.

◆ processFramePolicy

- (FMLiveSwitchProcessFramePolicy) processFramePolicy

Gets the ProcessFramePolicy for this media input.

◆ processSdpContentAttribute:isLocalDescription:

- (void) processSdpContentAttribute: (FMLiveSwitchSdpContentAttribute *)  sdpContentAttribute
isLocalDescription: (bool)  isLocalDescription 

Processes an SDP content attribute.

Parameters
sdpContentAttributeThe SDP content attribute.
isLocalDescriptionWhether the SDP content attribute comes from a local description.

Implemented in FMLiveSwitchVideoStream, and FMLiveSwitchAudioStream.

◆ processSdpMediaDescriptionFromInputWithMediaDescription:isOffer:isLocalDescription:

- (FMLiveSwitchError*) processSdpMediaDescriptionFromInputWithMediaDescription: (FMLiveSwitchSdpMediaDescription *)  mediaDescription
isOffer: (bool)  isOffer
isLocalDescription: (bool)  isLocalDescription 

Processes a local SDP media description from an input.

Parameters
mediaDescriptionThe media description.
isOfferif set to true [is offer].
isLocalDescriptionif set to true [is local description].

◆ processSdpMediaDescriptionFromOutputWithMediaDescription:isOffer:isLocalDescription:

- (FMLiveSwitchError*) processSdpMediaDescriptionFromOutputWithMediaDescription: (FMLiveSwitchSdpMediaDescription *)  mediaDescription
isOffer: (bool)  isOffer
isLocalDescription: (bool)  isLocalDescription 

Processes a local SDP media description from an output.

Parameters
mediaDescriptionThe media description.
isOfferif set to true [is offer].
isLocalDescriptionif set to true [is local description].

◆ processSinkStatsFromInputWithSinkStats:

- (void) processSinkStatsFromInputWithSinkStats: (FMLiveSwitchMediaSinkStats *)  sinkStats

Processes sink stats from an input.

Parameters
sinkStatsThe sink stats.

◆ processSourceStatsFromOutputWithSourceStats:

- (void) processSourceStatsFromOutputWithSourceStats: (FMLiveSwitchMediaSourceStats *)  sourceStats

Processes source stats from an output.

Parameters
sourceStatsThe source stats.

◆ processTrackStatsFromInputWithTrackStats:

- (void) processTrackStatsFromInputWithTrackStats: (FMLiveSwitchMediaTrackStats *)  trackStats

Processes stats from an input.

Parameters
trackStatsThe track stats.

◆ processTrackStatsFromOutputWithTrackStats:

- (void) processTrackStatsFromOutputWithTrackStats: (FMLiveSwitchMediaTrackStats *)  trackStats

Processes stats from an output.

Parameters
trackStatsThe track stats.

◆ raiseBitrateNotification:

- (bool) raiseBitrateNotification: (FMLiveSwitchBitrateNotification *)  bitrateNotification

Raises a bitrate notification to the remote track.

Parameters
bitrateNotificationThe bitrate notification.

◆ raiseBitrateRequest:

- (bool) raiseBitrateRequest: (FMLiveSwitchBitrateRequest *)  bitrateRequest

Raises a bitrate request to the local track.

Parameters
bitrateRequestThe bitrate request.

◆ raiseFrame:

- (void) raiseFrame: (TFrame)  frame

Raises a frame.

Parameters
frameThe frame.

◆ redFecConfig

- (FMLiveSwitchRedFecConfig*) redFecConfig

Gets Fec Config.

◆ redFecEnabled

- (bool) redFecEnabled

Gets True if Red Fec is negotiated.

◆ redFecPolicy

- (FMLiveSwitchRedFecPolicy) redFecPolicy

Gets the Fec Policy.

◆ rembEnabled

- (bool) rembEnabled

Gets True if goog-remb is negotiated.

◆ rembPolicy

- (FMLiveSwitchRembPolicy) rembPolicy

Gets the goog-remb policy.

◆ remoteDescriptionMediaId

- (NSString*) remoteDescriptionMediaId

Gets the remote description media identifier.

◆ remoteDescriptionTrackId

- (NSString*) remoteDescriptionTrackId

Gets the remote description track identifier.

◆ remoteEncoding

- (FMLiveSwitchEncodingInfo*) remoteEncoding

Gets the remote encoding.

◆ remoteMedia

- (FMLiveSwitchRemoteMedia*) remoteMedia

Gets the remote media, if one was specified.

◆ remoteTrack

- (TTrack) remoteTrack

Gets the remote track, if one was specified.

◆ removeInput:

- (bool) removeInput: (TIOutput)  input

Removes an input.

Parameters
inputThe input.

◆ removeInputs

- (void) removeInputs

Removes all inputs.

◆ removeInputs:

- (void) removeInputs: (NSMutableArray *)  inputs

Removes some inputs.

Parameters
inputsThe inputs.

◆ removeOnDiscardBitrateNotification:

- (void) removeOnDiscardBitrateNotification: (FMLiveSwitchAction1< FMLiveSwitchBitrateNotification * > *)  value

Removes a handler that is raised when a bitrate notification is discarded due to policy restrictions or lack of support by the remote endpoint.

◆ removeOnDiscardBitrateRequest:

- (void) removeOnDiscardBitrateRequest: (FMLiveSwitchAction1< FMLiveSwitchBitrateRequest * > *)  value

Removes a handler that is raised when a bitrate notification message is discarded by the internal in-band messaging mechanism because the peer does not support bitrate notifications.


In this case, the bitrate notification needs to be transported out of band. LiveSwitch handles this internally by sending the message over Data Streams. No further action is required by application developers.
Use this event for for diagnostics and debugging.

◆ removeOnDiscardOutboundControlFrame:

- (void) removeOnDiscardOutboundControlFrame: (FMLiveSwitchAction1< FMLiveSwitchMediaControlFrame * > *)  value

Removes a handler that is raised when an outbound control frame is discarded due to policy restrictions or lack of support by the remote endpoint.

◆ removeOnMasterSynchronizeContextReady:

- (void) removeOnMasterSynchronizeContextReady: (FMLiveSwitchAction1< FMLiveSwitchSynchronizeContext * > *)  value

Removes a handler that is raised by master streams when the synchronize context is ready.

◆ removeOnPausedChange:

- (void) removeOnPausedChange: (FMLiveSwitchAction0 *)  value

Removes a handler that is raised when the Paused property changes state.

◆ removeOnProcessControlFrameResponses:

- (void) removeOnProcessControlFrameResponses: (FMLiveSwitchAction1< NSMutableArray * > *)  value

Removes a handler that is raised when control frame responses are processed.

◆ removeOnProcessControlFrames:

- (void) removeOnProcessControlFrames: (FMLiveSwitchAction1< NSMutableArray * > *)  value

Removes a handler that is raised when control frames are processed.

◆ removeOnProcessedFrame:

- (void) removeOnProcessedFrame: (FMLiveSwitchAction1< TFrame > *)  value

Removes a handler that is raised when a frame has been processed.

◆ removeOnProcessFrame:

- (void) removeOnProcessFrame: (FMLiveSwitchAction1< TFrame > *)  value

Removes a handler that is raised when a frame is being processed.

◆ removeOnRaiseControlFrameResponses:

- (void) removeOnRaiseControlFrameResponses: (FMLiveSwitchAction1< NSMutableArray * > *)  value

Removes a handler that is raised when control frame responses are raised.

◆ removeOnRaiseControlFrames:

- (void) removeOnRaiseControlFrames: (FMLiveSwitchAction1< NSMutableArray * > *)  value

Removes a handler that is raised when control frames are raised.

◆ removeOnRaisedFrame:

- (void) removeOnRaisedFrame: (FMLiveSwitchAction1< TFrame > *)  value

Removes a handler that is raised when a frame has been raised.

◆ removeOnRaiseFrame:

- (void) removeOnRaiseFrame: (FMLiveSwitchAction1< TFrame > *)  value

Removes a handler that is raised when a frame is being raised.

◆ removeOnReceiveFrame:

- (void) removeOnReceiveFrame: (FMLiveSwitchAction1< TFrame > *)  value

Removes a handler that is raised when a frame is received.

◆ removeOnSendFrame:

- (void) removeOnSendFrame: (FMLiveSwitchAction1< TFrame > *)  value

Removes a handler that is raised when a frame is sent.

◆ removeOutput:

- (bool) removeOutput: (TIInput)  output

Removes an output.

Parameters
outputThe output.

◆ removeOutputs

- (void) removeOutputs

Removes all outputs.

◆ removeOutputs:

- (void) removeOutputs: (NSMutableArray *)  outputs

Removes some outputs.

Parameters
outputsThe outputs.

◆ setBandwidthAdaptationPolicy:

- (void) setBandwidthAdaptationPolicy: (FMLiveSwitchBandwidthAdaptationPolicy)  value

Sets bandwidth adapation policy for this stream.

◆ setCcmFirPolicy:

- (void) setCcmFirPolicy: (FMLiveSwitchCcmFirPolicy)  value

Sets the CCM FIR Policy.

◆ setCcmLrrPolicy:

- (void) setCcmLrrPolicy: (FMLiveSwitchCcmLrrPolicy)  value

Sets the CCM LRR Policy.

◆ setCcmTmmbnPolicy:

- (void) setCcmTmmbnPolicy: (FMLiveSwitchCcmTmmbnPolicy)  value

Sets the CCM TMMBR Policy.

◆ setCcmTmmbrPolicy:

- (void) setCcmTmmbrPolicy: (FMLiveSwitchCcmTmmbrPolicy)  value

Sets the CCM TMMBR Policy.

◆ setDisableAutomaticReports:

- (void) setDisableAutomaticReports: (bool)  value

Sets a value indicating whether to disable automatic RTCP sender/receiver reports.

◆ setInputMuted:

- (void) setInputMuted: (bool)  value

Sets whether the input track is muted.

◆ setInputRtpStreamId:

- (void) setInputRtpStreamId: (NSString *)  value

Sets null to satisfy interface requirements.

◆ setInputSourceMutedWithInput:value:

- (void) setInputSourceMutedWithInput: (TIOutput)  input
value: (bool)  value 

Sets whether an input source is muted.

Parameters
inputThe input.
valueThe value.

◆ setInputSourceMutedWithInputs:value:

- (void) setInputSourceMutedWithInputs: (NSMutableArray *)  inputs
value: (bool)  value 

Sets whether an input source is muted.

Parameters
inputsThe inputs.
valueThe value.

◆ setInputSynchronizationDisabled:

- (void) setInputSynchronizationDisabled: (bool)  value

Sets whether input synchronization is disabled.

◆ setInputSynchronizationSource:

- (void) setInputSynchronizationSource: (long long)  value

Sets -1 to satisfy interface requirements.

◆ setLegacyReceiver:

- (void) setLegacyReceiver: (bool)  value

Sets whether to use legacy receiver processing.

Legacy receiver processing uses a fixed-size jitter buffer and processes forward error correction pre-jitter.

◆ setLocalDescriptionMediaId:

- (void) setLocalDescriptionMediaId: (NSString *)  value

Sets the local description media identifier.

If not set, defaults to the FMLiveSwitchMediaStream`15localMedia identifier, if one exists.

◆ setLocalDescriptionTrackId:

- (void) setLocalDescriptionTrackId: (NSString *)  value

Sets the local description track identifier.

If not set, defaults to the FMLiveSwitchMediaStream`15localTrack identifier, if one exists.

◆ setLocalMedia:

- (void) setLocalMedia: (FMLiveSwitchLocalMedia *)  value

Sets the local media, if one was specified.

◆ setLocalTrack:

- (void) setLocalTrack: (TTrack)  value

Sets the local track from this media.

Returns null if there are no tracks.

◆ setMaxReceiveBitrate:

- (void) setMaxReceiveBitrate: (int)  value

Sets the maximum desired receive bitrate, in kbps.

◆ setNackPliPolicy:

- (void) setNackPliPolicy: (FMLiveSwitchNackPliPolicy)  value

Sets the NACK PLI Policy.

◆ setNackPolicy:

- (void) setNackPolicy: (FMLiveSwitchNackPolicy)  value

Sets the NACK Policy.

◆ setOutputFormat:

- (void) setOutputFormat: (TFormat)  value

Sets the output format.

◆ setOutputMuted:

- (void) setOutputMuted: (bool)  value

Sets whether the output track is muted.

◆ setOutputSinkMutedWithOutput:value:

- (void) setOutputSinkMutedWithOutput: (TIInput)  output
value: (bool)  value 

Sets whether an output source is muted.

Parameters
outputThe output.
valueThe value.

◆ setOutputSinkMutedWithOutputs:value:

- (void) setOutputSinkMutedWithOutputs: (NSMutableArray *)  outputs
value: (bool)  value 

Sets whether an output sink is muted.

Parameters
outputsThe outputs.
valueThe value.

◆ setOutputSynchronizationDisabled:

- (void) setOutputSynchronizationDisabled: (bool)  value

Sets whether output synchronization is disabled.

◆ setProcessFramePolicy:

- (void) setProcessFramePolicy: (FMLiveSwitchProcessFramePolicy)  value

Sets the ProcessFramePolicy for this media input.

◆ setRedFecPolicy:

- (void) setRedFecPolicy: (FMLiveSwitchRedFecPolicy)  value

Sets the Fec Policy.

◆ setRemoteEncoding:

- (void) setRemoteEncoding: (FMLiveSwitchEncodingInfo *)  value

Sets the remote encoding.

◆ setRemoteMedia:

- (void) setRemoteMedia: (FMLiveSwitchRemoteMedia *)  value

Sets the remote media, if one was specified.

◆ setRemoteTrack:

- (void) setRemoteTrack: (TTrack)  value

Sets the remote track, if one was specified.

◆ setSimulcastMode:

- (void) setSimulcastMode: (FMLiveSwitchSimulcastMode)  value

Sets the simulcast mode.

◆ setSynchronizeContext:

- (void) setSynchronizeContext: (FMLiveSwitchSynchronizeContext *)  value

Sets the synchronize context.

◆ setSystemDelay:

- (void) setSystemDelay: (long long)  value

Sets the system delay in ticks.

◆ simulcastMode

- (FMLiveSwitchSimulcastMode) simulcastMode

Gets the simulcast mode.

◆ synchronizeContext

- (FMLiveSwitchSynchronizeContext*) synchronizeContext

Gets the synchronize context.

◆ synchronizers

- (NSMutableArray*) synchronizers

Gets all synchronizers in the stream output tracks.

◆ synchronizeWithMaster:

- (void) synchronizeWithMaster: (bool)  master

Initializes synchronization.

Parameters
masterWhether this is a master stream.

◆ systemDelay

- (long long) systemDelay

Gets the system delay in ticks.

◆ targetOutputBitrate

- (int) targetOutputBitrate

Gets the target output bitrate, in kbps.

A value of -1 indicates unset (no target).

◆ targetOutputEncoding

- (FMLiveSwitchEncodingInfo*) targetOutputEncoding

Gets the target output encoding.

Implemented in FMLiveSwitchVideoStream.

◆ transportInfo

- (FMLiveSwitchTransportInfo*) transportInfo

Gets transport information.

Member Data Documentation

◆ __pad0__

- __pad0__
protected

◆ FMLiveSwitchIElement

- FMLiveSwitchIElement
protected

◆ FMLiveSwitchIInput

- FMLiveSwitchIInput
protected

◆ FMLiveSwitchIMediaElement

◆ FMLiveSwitchIMediaInput

◆ FMLiveSwitchIMediaStream

◆ FMLiveSwitchIOutput

- FMLiveSwitchIOutput
protected

◆ FMLiveSwitchIStream

- FMLiveSwitchIStream
protected