<FMLiveSwitchIMediaElement> Protocol Reference

A media element. More...

Instance Methods

(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...
 
- 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...
 

Detailed Description

A media element.

Method Documentation

◆ deactivated

- (bool) deactivated

Gets a value indicating whether this instance is deactivated.

◆ destroy

◆ disabled

- (bool) disabled

Gets a value indicating whether this instance is disabled.

Reimplemented in FMLiveSwitchDtmfReceiver.

◆ label

- (NSString*) label

Gets a label that identifies this instance.

Reimplemented in FMLiveSwitchYuvImageScaler, FMLiveSwitchYuvImageConverter, FMLiveSwitchVp9Encoder, FMLiveSwitchVp9Decoder, FMLiveSwitchVp8Encoder, FMLiveSwitchVp8Decoder, FMLiveSwitchOpusEncoder, FMLiveSwitchOpusDecoder, FMLiveSwitchCocoaVideoToolboxH265Encoder, FMLiveSwitchCocoaVideoToolboxH265Decoder, FMLiveSwitchCocoaVideoToolboxH264Encoder, FMLiveSwitchCocoaVideoToolboxH264Decoder, FMLiveSwitchYuv4MpegVideoSource, FMLiveSwitchYuv4MpegVideoSink, FMLiveSwitchWaveAudioSink, FMLiveSwitchVp9Packetizer, FMLiveSwitchVp8Packetizer, FMLiveSwitchVideoTrack, FMLiveSwitchVideoSynchronizer, FMLiveSwitchVideoBranch, FMLiveSwitchSoundReframer, FMLiveSwitchSoundConverter, FMLiveSwitchResetVideoPipe, FMLiveSwitchResetAudioPipe, FMLiveSwitchPcmuPacketizer, FMLiveSwitchPcmuEncoder, FMLiveSwitchPcmuDepacketizer, FMLiveSwitchPcmuDecoder, FMLiveSwitchPcmaPacketizer, FMLiveSwitchPcmaEncoder, FMLiveSwitchPcmaDepacketizer, FMLiveSwitchPcmaDecoder, FMLiveSwitchOpusPacketizer, FMLiveSwitchOpusDepacketizer, FMLiveSwitchOggAudioSink, FMLiveSwitchNullVideoSource, FMLiveSwitchNullVideoSink, FMLiveSwitchNullAudioSource, FMLiveSwitchNullAudioSink, FMLiveSwitchMatroskaVideoSource, FMLiveSwitchMatroskaVideoSink, FMLiveSwitchMatroskaAudioSource, FMLiveSwitchMatroskaAudioSink, FMLiveSwitchL16Encoder, FMLiveSwitchL16Decoder, FMLiveSwitchJitterVideoPipe, FMLiveSwitchJitterAudioPipe, FMLiveSwitchIvfVideoSink, FMLiveSwitchImageSizePipe, FMLiveSwitchImageScalePipe, FMLiveSwitchIdentityVideoPipe, FMLiveSwitchIdentityAudioPipe, FMLiveSwitchH265Packetizer, FMLiveSwitchH264Packetizer, FMLiveSwitchG722Packetizer, FMLiveSwitchG722Encoder, FMLiveSwitchG722Depacketizer, FMLiveSwitchG722Decoder, FMLiveSwitchFrameRatePipe, FMLiveSwitchFrameRateController, FMLiveSwitchFakeVideoSource, FMLiveSwitchFakeAudioSource, FMLiveSwitchDtmfSender, FMLiveSwitchDtmfReceiver, FMLiveSwitchBasicVideoPacketizer, FMLiveSwitchBasicAudioPacketizer, FMLiveSwitchBasicAudioDepacketizer, FMLiveSwitchAudioTrack, FMLiveSwitchAudioSynchronizer, FMLiveSwitchAudioMixer, and FMLiveSwitchAudioBranch.

◆ muted

- (bool) muted

Gets a value indicating whether this instance is muted.

◆ paused

- (bool) paused

Gets a value indicating whether this instance is paused.

◆ persistent

- (bool) persistent

Gets a value indicating whether this instance is persistent.

If true, this element will not be destroyed unless FMLiveSwitchIMediaElement::destroy is called explicitly on this instance. It will survive destruction of any parent elements that are being destroyed.

◆ setDeactivated:

- (void) setDeactivated: (bool)  value

Sets a value indicating whether this instance is deactivated.

◆ setMuted:

- (void) setMuted: (bool)  value

Sets a value indicating whether this instance is muted.