<FMLiveSwitchIAudioInput> Protocol Reference

An audio input. More...

Instance Methods

(FMLiveSwitchAudioConfig *) - config
 Gets the configuration. More...
 
(double) - gain
 Gets a value indicating the gain (input amplification) of this sink. More...
 
(void) - setGain:
 Sets a value indicating the gain (input amplification) of this sink. More...
 
- Instance Methods inherited from <FMLiveSwitchIMediaInput>
(void) - addOnDisabledChange:
 Adds a handler that is raised when the Disabled property changes state. 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) - addOnProcessFrame:
 Adds a handler that is raised when a frame is processed. More...
 
(FMLiveSwitchMediaFrame *) - addOnProcessFrameWithBlock
 Adds a handler that is raised when a frame is processed. More...
 
(void) - addOnProcessFrameWithBlock:
 Adds a handler that is raised when a frame is processed. 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...
 
(long long) - getPipelineSystemDelayWithOutputFormat:
 Gets the total pipeline system delay in ticks for a given media format. More...
 
(bool) - inputDeactivated
 Gets whether input is deactivated. More...
 
(bool) - inputMuted
 Gets whether input is muted. More...
 
(NSString *) - inputRtpStreamId
 Gets the input RTP stream identifier. More...
 
(long long) - inputSynchronizationSource
 Gets the input synchronization source. More...
 
(int) - maxInputBitrate
 Gets the maximum allowed input bitrate, in kbps. More...
 
(FMLiveSwitchEncodingInfo *) - maxInputEncoding
 Gets the maximum allowed input encoding. More...
 
(int) - minInputBitrate
 Gets the minimum allowed input bitrate, in kbps. More...
 
(FMLiveSwitchEncodingInfo *) - minInputEncoding
 Gets the minimum allowed input encoding. More...
 
(void) - processControlFrameResponses:
 Processes control frame responses. More...
 
(bool) - processFrame:
 Processes a frame. More...
 
(FMLiveSwitchProcessFramePolicy) - processFramePolicy
 Gets the ProcessFramePolicy for this media input. More...
 
(FMLiveSwitchError *) - processSdpMediaDescriptionFromInputWithMediaDescription:isOffer:isLocalDescription:
 Processes a local SDP media description from an input. More...
 
(void) - processSinkStatsFromInputWithSinkStats:
 Processes sink stats from an input. More...
 
(void) - processTrackStatsFromInputWithTrackStats:
 Processes track stats from an input. More...
 
(void) - removeOnDisabledChange:
 Removes a handler that is raised when the Disabled property changes state. 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) - removeOnProcessFrame:
 Removes a handler that is raised when a frame is processed. More...
 
(void) - removeOnRaiseControlFrames:
 Removes a handler that is raised when control frames are raised. More...
 
(void) - setInputRtpStreamId:
 Sets the input RTP stream identifier. More...
 
(void) - setInputSynchronizationSource:
 Sets the input synchronization source. More...
 
(void) - setProcessFramePolicy:
 Sets the ProcessFramePolicy for this media input. More...
 
(long long) - systemDelay
 Gets the system delay in ticks. More...
 
- Instance Methods inherited from <FMLiveSwitchIInput>
(void) - addInput:
 Adds an input. More...
 
(void) - addInputs:
 Adds some inputs. More...
 
(NSObject< FMLiveSwitchIOutput > *) - input
 Gets the input. More...
 
(FMLiveSwitchMediaFormat *) - inputFormat
 Gets the input format. More...
 
(NSMutableArray *) - inputs
 Gets the inputs. More...
 
(NSString *) - pipelineJsonFromInput
 Gets the pipeline JSON from an input. More...
 
(bool) - removeInput:
 Removes an input. More...
 
(void) - removeInputs
 Removes all inputs. More...
 
(void) - removeInputs:
 Removes some inputs. More...
 
- Instance Methods inherited from <FMLiveSwitchIElement>
(NSString *) - externalId
 Gets the external identifier. More...
 
(NSString *) - id
 Gets the identifier. More...
 
(NSString *) - pipelineJson
 Gets the pipeline JSON with this as the central point. More...
 
(void) - setExternalId:
 Sets the external identifier. More...
 
- Instance Methods inherited from <FMLiveSwitchIMediaElement>
(bool) - deactivated
 Gets a value indicating whether this instance is deactivated. More...
 
(bool) - destroy
 Destroys this instance. More...
 
(bool) - disabled
 Gets a value indicating whether this instance is disabled. More...
 
(NSString *) - label
 Gets a label that identifies this instance. More...
 
(bool) - muted
 Gets a value indicating whether this instance is muted. More...
 
(bool) - paused
 Gets a value indicating whether this instance is paused. More...
 
(bool) - persistent
 Gets a value indicating whether this instance is persistent. More...
 
(void) - setDeactivated:
 Sets a value indicating whether this instance is deactivated. More...
 
(void) - setMuted:
 Sets a value indicating whether this instance is muted. More...
 

Detailed Description

An audio input.

Method Documentation

◆ config

Gets the configuration.

◆ gain

- (double) gain

Gets a value indicating the gain (input amplification) of this sink.

Any value greater than or equal to 0.0 is acceptable.

◆ setGain:

- (void) setGain: (double)  value

Sets a value indicating the gain (input amplification) of this sink.

Any value greater than or equal to 0.0 is acceptable.