Search Results for

    Show / Hide Table of Contents

    Class RtcLocalMedia<TView>

    A WebRTC/ORTC-compatible collection of local audio/video tracks.

    Inheritance
    System.Object
    Serializable
    Dynamic
    MediaBase<AudioTrack, VideoTrack>
    Media<AudioTrack, VideoTrack>
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>
    LocalMedia
    RtcLocalMedia<TView>
    Implements
    ILocalMedia<LocalMedia, AudioTrack, VideoTrack>
    IMedia<AudioTrack, VideoTrack>
    IViewSinkableMedia<TView, ViewSink<TView>>
    IViewableMedia<TView>
    Inherited Members
    LocalMedia.OnAudioMuted
    LocalMedia.OnAudioUnmuted
    LocalMedia.OnVideoMuted
    LocalMedia.OnVideoUnmuted
    LocalMedia.OnAudioStarted
    LocalMedia.OnVideoStarted
    LocalMedia.OnAudioStopped
    LocalMedia.OnVideoStopped
    LocalMedia.AddAudioTrack(AudioTrack)
    LocalMedia.RemoveAudioTrack(AudioTrack)
    LocalMedia.AddVideoTrack(VideoTrack)
    LocalMedia.RemoveVideoTrack(VideoTrack)
    LocalMedia.GetAudioSourceInputs()
    LocalMedia.GetVideoSourceInputs()
    LocalMedia.AudioSourceInput
    LocalMedia.VideoSourceInput
    LocalMedia.ChangeAudioSourceInput(SourceInput)
    LocalMedia.ChangeVideoSourceInput(SourceInput)
    LocalMedia.AudioSource
    LocalMedia.AudioSources
    LocalMedia.VideoSource
    LocalMedia.VideoSources
    LocalMedia.MediaSources
    LocalMedia.DoStart()
    LocalMedia.DoStop()
    LocalMedia.CreateAudioTrackCollection()
    LocalMedia.CreateVideoTrackCollection()
    LocalMedia.ArrayFromAudioTracks(List<AudioTrack>)
    LocalMedia.ArrayFromVideoTracks(List<VideoTrack>)
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.State
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.AudioEncoding
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.AudioEncodings
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.VideoEncoding
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.VideoEncodings
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.DoGetAudioEncodings()
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.DoSetAudioEncodings(AudioEncodingConfig[])
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.DoGetVideoEncodings()
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.DoSetVideoEncodings(VideoEncodingConfig[])
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.LockAudioEncodings()
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.LockVideoEncodings()
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.LockVideoEncodings(VideoType)
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.LockVideoEncodings(VideoType, Int32, Int32, Double)
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.AudioSimulcastDisabled
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.AudioSimulcastEncodingCount
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.AudioSimulcastPreferredBitrate
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.VideoSimulcastDisabled
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.VideoSimulcastEncodingCount
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.VideoSimulcastPreferredBitrate
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.VideoSimulcastBitsPerPixel
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.VideoSimulcastDegradationPreference
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.DefaultVideoBitsPerPixel
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.Start()
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.DoStart()
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.Stop()
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.DoStop()
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.AbortStart(Promise<LocalMedia>, Exception)
    Media<AudioTrack, VideoTrack>.AudioLevelInterval
    Media<AudioTrack, VideoTrack>.AudioTracks
    Media<AudioTrack, VideoTrack>.VideoTracks
    Media<AudioTrack, VideoTrack>.OnAudioLevel
    Media<AudioTrack, VideoTrack>.OnVideoSize
    Media<AudioTrack, VideoTrack>.OnVideoSizeChange
    Media<AudioTrack, VideoTrack>.OnAudioDestroyed
    Media<AudioTrack, VideoTrack>.OnVideoDestroyed
    Media<AudioTrack, VideoTrack>.AddAudioTrack(AudioTrack)
    Media<AudioTrack, VideoTrack>.RemoveAudioTrack(AudioTrack)
    Media<AudioTrack, VideoTrack>.AddVideoTrack(VideoTrack)
    Media<AudioTrack, VideoTrack>.RemoveVideoTrack(VideoTrack)
    Media<AudioTrack, VideoTrack>.IsRecordingAudio
    Media<AudioTrack, VideoTrack>.IsRecordingVideo
    Media<AudioTrack, VideoTrack>.VideoSize
    Media<AudioTrack, VideoTrack>.GrabVideoFrame()
    Media<AudioTrack, VideoTrack>.Destroy()
    Media<AudioTrack, VideoTrack>.CreateAudioTrackCollection()
    Media<AudioTrack, VideoTrack>.CreateVideoTrackCollection()
    Media<AudioTrack, VideoTrack>.ArrayFromAudioTracks(List<AudioTrack>)
    Media<AudioTrack, VideoTrack>.ArrayFromVideoTracks(List<VideoTrack>)
    MediaBase<AudioTrack, VideoTrack>.Id
    MediaBase<AudioTrack, VideoTrack>.AudioTrack
    MediaBase<AudioTrack, VideoTrack>.VideoTrack
    MediaBase<AudioTrack, VideoTrack>.AudioGain
    MediaBase<AudioTrack, VideoTrack>.AudioVolume
    MediaBase<AudioTrack, VideoTrack>.AudioMuted
    MediaBase<AudioTrack, VideoTrack>.VideoMuted
    Dynamic.DynamicProperties
    Dynamic.GetDynamicValue(String)
    Dynamic.SetDynamicValue(String, Object)
    Dynamic.UnsetDynamicValue(String)
    Serializable.IsDirty
    Namespace: FM.LiveSwitch
    Assembly: FM.LiveSwitch.dll
    Syntax
    public abstract class RtcLocalMedia<TView> : LocalMedia, ILocalMedia<LocalMedia, AudioTrack, VideoTrack>, IMedia<AudioTrack, VideoTrack>, IViewSinkableMedia<TView, ViewSink<TView>>, IViewableMedia<TView>
    Type Parameters
    Name Description
    TView

    Constructors

    RtcLocalMedia()

    Initializes a new instance of the RtcLocalMedia<TView> class.

    Declaration
    public RtcLocalMedia()

    RtcLocalMedia(Boolean, Boolean)

    Initializes a new instance of the RtcLocalMedia<TView> class.

    Declaration
    public RtcLocalMedia(bool disableAudio, bool disableVideo)
    Parameters
    Type Name Description
    System.Boolean disableAudio

    Whether to disable audio.

    System.Boolean disableVideo

    Whether to disable video.

    RtcLocalMedia(Boolean, Boolean, AecContext)

    Initializes a new instance of the RtcLocalMedia<TView> class.

    Declaration
    public RtcLocalMedia(bool disableAudio, bool disableVideo, AecContext aecContext)
    Parameters
    Type Name Description
    System.Boolean disableAudio

    Whether to disable audio.

    System.Boolean disableVideo

    Whether to disable video.

    AecContext aecContext

    The acoustic echo cancellation context.

    Properties

    ActiveAudioConverter

    Gets the active audio converter.

    Declaration
    public AudioPipe ActiveAudioConverter { get; }
    Property Value
    Type Description
    AudioPipe

    ActiveAudioEncoder

    Gets the active audio encoder.

    Declaration
    public AudioEncoder ActiveAudioEncoder { get; }
    Property Value
    Type Description
    AudioEncoder

    ActiveAudioPacketizer

    Gets the active audio packetizer.

    Declaration
    public AudioPipe ActiveAudioPacketizer { get; }
    Property Value
    Type Description
    AudioPipe

    ActiveVideoController

    Gets the active video controller.

    Declaration
    public VideoPipe ActiveVideoController { get; }
    Property Value
    Type Description
    VideoPipe

    ActiveVideoConverter

    Gets the active video converter.

    Declaration
    public VideoPipe ActiveVideoConverter { get; }
    Property Value
    Type Description
    VideoPipe

    ActiveVideoEncoder

    Gets the active video encoder.

    Declaration
    public VideoEncoder ActiveVideoEncoder { get; }
    Property Value
    Type Description
    VideoEncoder

    ActiveVideoPacketizer

    Gets the active video packetizer.

    Declaration
    public VideoPipe ActiveVideoPacketizer { get; }
    Property Value
    Type Description
    VideoPipe

    AecContext

    Gets the acoustic echo cancellation context.

    Declaration
    public AecContext AecContext { get; }
    Property Value
    Type Description
    AecContext

    AecDisabled

    Gets a value indicating whether acoustic echo cancellation is disabled.

    Declaration
    public bool AecDisabled { get; }
    Property Value
    Type Description
    System.Boolean

    AudioDisabled

    Gets a value indicating whether audio is disabled.

    Declaration
    public bool AudioDisabled { get; }
    Property Value
    Type Description
    System.Boolean

    AudioOutputs

    Gets the audio outputs.

    Declaration
    public IAudioOutput[] AudioOutputs { get; }
    Property Value
    Type Description
    IAudioOutput[]

    AutomaticVideoDegradation

    Gets or sets whether to automatically degrade video based on VideoBitsPerPixel and VideoDegradationPreference when bitrate constraints are applied to the local encoders.

    Declaration
    public bool AutomaticVideoDegradation { get; set; }
    Property Value
    Type Description
    System.Boolean

    G722Converter

    Gets the G.722 converter.

    Declaration
    public AudioPipe G722Converter { get; }
    Property Value
    Type Description
    AudioPipe

    G722Disabled

    Gets whether the G.722 codec is disabled.

    Declaration
    public bool G722Disabled { get; }
    Property Value
    Type Description
    System.Boolean

    G722Encoder

    Gets the G.722 encoder.

    Declaration
    public AudioEncoder G722Encoder { get; }
    Property Value
    Type Description
    AudioEncoder

    G722Packetizer

    Gets the G.722 packetizer.

    Declaration
    public AudioPipe G722Packetizer { get; }
    Property Value
    Type Description
    AudioPipe

    H264Controller

    Gets the first H.264 controller.

    Declaration
    public VideoPipe H264Controller { get; }
    Property Value
    Type Description
    VideoPipe

    H264Controllers

    Gets the H.264 controllers.

    Declaration
    public VideoPipe[] H264Controllers { get; }
    Property Value
    Type Description
    VideoPipe[]

    H264Converter

    Gets the first H.264 converter.

    Declaration
    public VideoPipe H264Converter { get; }
    Property Value
    Type Description
    VideoPipe

    H264Converters

    Gets the H.264 converters.

    Declaration
    public VideoPipe[] H264Converters { get; }
    Property Value
    Type Description
    VideoPipe[]

    H264ConvertersArray

    Gets the H.264 converters array.

    Declaration
    public VideoPipe[][] H264ConvertersArray { get; }
    Property Value
    Type Description
    VideoPipe[][]

    H264Disabled

    Gets whether the H.264 codec is disabled.

    Declaration
    public bool H264Disabled { get; }
    Property Value
    Type Description
    System.Boolean

    H264Encoder

    Gets the first H.264 encoder.

    Declaration
    public VideoEncoder H264Encoder { get; }
    Property Value
    Type Description
    VideoEncoder

    H264Encoders

    Gets the first H.264 encoders.

    Declaration
    public VideoEncoder[] H264Encoders { get; }
    Property Value
    Type Description
    VideoEncoder[]

    H264EncodersArray

    Gets the H.264 encoders array.

    Declaration
    public VideoEncoder[][] H264EncodersArray { get; }
    Property Value
    Type Description
    VideoEncoder[][]

    H264Packetizer

    Gets the first H.264 packetizer.

    Declaration
    public VideoPipe H264Packetizer { get; }
    Property Value
    Type Description
    VideoPipe

    H264Packetizers

    Gets the first H.264 packetizers.

    Declaration
    public VideoPipe[] H264Packetizers { get; }
    Property Value
    Type Description
    VideoPipe[]

    H264PacketizersArray

    Gets the first H.264 packetizers array.

    Declaration
    public VideoPipe[][] H264PacketizersArray { get; }
    Property Value
    Type Description
    VideoPipe[][]

    H264PacketizersArrayArray

    Gets the H.264 packetizers array array.

    Declaration
    public VideoPipe[][][] H264PacketizersArrayArray { get; }
    Property Value
    Type Description
    VideoPipe[][][]

    H265Controller

    Gets the first H265 controller.

    Declaration
    public VideoPipe H265Controller { get; }
    Property Value
    Type Description
    VideoPipe

    H265Controllers

    Gets the H265 controllers.

    Declaration
    public VideoPipe[] H265Controllers { get; }
    Property Value
    Type Description
    VideoPipe[]

    H265Converter

    Gets the first H265 converter.

    Declaration
    public VideoPipe H265Converter { get; }
    Property Value
    Type Description
    VideoPipe

    H265Converters

    Gets the H265 converters.

    Declaration
    public VideoPipe[] H265Converters { get; }
    Property Value
    Type Description
    VideoPipe[]

    H265Disabled

    Gets whether the H.265 codec is disabled.

    Declaration
    public bool H265Disabled { get; }
    Property Value
    Type Description
    System.Boolean

    H265Encoder

    Gets the first H265 encoder.

    Declaration
    public VideoEncoder H265Encoder { get; }
    Property Value
    Type Description
    VideoEncoder

    H265Encoders

    Gets the H265 encoders.

    Declaration
    public VideoEncoder[] H265Encoders { get; }
    Property Value
    Type Description
    VideoEncoder[]

    H265Packetizer

    Gets the first H265 packetizer.

    Declaration
    public VideoPipe H265Packetizer { get; }
    Property Value
    Type Description
    VideoPipe

    H265Packetizers

    Gets the H265 packetizers.

    Declaration
    public VideoPipe[] H265Packetizers { get; }
    Property Value
    Type Description
    VideoPipe[]

    L16Converter

    Gets the L16 converter.

    Declaration
    public AudioPipe L16Converter { get; }
    Property Value
    Type Description
    AudioPipe

    L16Disabled

    Gets whether the L16 codec is disabled.

    Declaration
    public bool L16Disabled { get; }
    Property Value
    Type Description
    System.Boolean

    L16Encoder

    Gets the L16 encoder.

    Declaration
    public AudioEncoder L16Encoder { get; }
    Property Value
    Type Description
    AudioEncoder

    L16Packetizer

    Gets the L16 packetizer.

    Declaration
    public AudioPipe L16Packetizer { get; }
    Property Value
    Type Description
    AudioPipe

    OpusConverter

    Gets the first Opus converter.

    Declaration
    public AudioPipe OpusConverter { get; }
    Property Value
    Type Description
    AudioPipe

    OpusConverters

    Gets the Opus converters.

    Declaration
    public AudioPipe[] OpusConverters { get; }
    Property Value
    Type Description
    AudioPipe[]

    OpusDisabled

    Gets whether the Opus codec is disabled.

    Declaration
    public bool OpusDisabled { get; }
    Property Value
    Type Description
    System.Boolean

    OpusEncoder

    Gets the first Opus encoder.

    Declaration
    public AudioEncoder OpusEncoder { get; }
    Property Value
    Type Description
    AudioEncoder

    OpusEncoders

    Gets the Opus encoders.

    Declaration
    public AudioEncoder[] OpusEncoders { get; }
    Property Value
    Type Description
    AudioEncoder[]

    OpusPacketizer

    Gets the first Opus packetizer.

    Declaration
    public AudioPipe OpusPacketizer { get; }
    Property Value
    Type Description
    AudioPipe

    OpusPacketizers

    Gets the Opus packetizers.

    Declaration
    public AudioPipe[] OpusPacketizers { get; }
    Property Value
    Type Description
    AudioPipe[]

    PacketizerDisabled

    Gets or sets a value indicating whether packetizer is disabled. WebRTC media requires RTP packetizer, so value must false. Media over WebSockets must not use RTP packetizer, so value must true. If packetizer is not required, this value must be set in the constructor.

    Declaration
    public bool PacketizerDisabled { get; protected set; }
    Property Value
    Type Description
    System.Boolean

    PcmaConverter

    Gets the PCMA converter.

    Declaration
    public AudioPipe PcmaConverter { get; }
    Property Value
    Type Description
    AudioPipe

    PcmaDisabled

    Gets whether the PCMA codec is disabled.

    Declaration
    public bool PcmaDisabled { get; }
    Property Value
    Type Description
    System.Boolean

    PcmaEncoder

    Gets the PCMA encoder.

    Declaration
    public AudioEncoder PcmaEncoder { get; }
    Property Value
    Type Description
    AudioEncoder

    PcmaPacketizer

    Gets the PCMA packetizer.

    Declaration
    public AudioPipe PcmaPacketizer { get; }
    Property Value
    Type Description
    AudioPipe

    PcmuConverter

    Gets the PCMU converter.

    Declaration
    public AudioPipe PcmuConverter { get; }
    Property Value
    Type Description
    AudioPipe

    PcmuDisabled

    Gets whether the PCMU codec is disabled.

    Declaration
    public bool PcmuDisabled { get; }
    Property Value
    Type Description
    System.Boolean

    PcmuEncoder

    Gets the PCMU encoder.

    Declaration
    public AudioEncoder PcmuEncoder { get; }
    Property Value
    Type Description
    AudioEncoder

    PcmuPacketizer

    Gets the PCMU packetizer.

    Declaration
    public AudioPipe PcmuPacketizer { get; }
    Property Value
    Type Description
    AudioPipe

    VideoBitsPerPixel

    Gets or sets the video degradation preference when bitrate constraints require a compromise on frame-rate and/or resolution.

    Declaration
    public double VideoBitsPerPixel { get; set; }
    Property Value
    Type Description
    System.Double

    VideoDegradationPreference

    Gets or sets the video degradation preference when bitrate constraints require a compromise on frame-rate and/or resolution.

    Declaration
    public VideoDegradationPreference VideoDegradationPreference { get; set; }
    Property Value
    Type Description
    VideoDegradationPreference

    VideoDisabled

    Gets a value indicating whether video is disabled.

    Declaration
    public bool VideoDisabled { get; }
    Property Value
    Type Description
    System.Boolean

    VideoOutputs

    Gets the video outputs.

    Declaration
    public IVideoOutput[] VideoOutputs { get; }
    Property Value
    Type Description
    IVideoOutput[]

    View

    Gets the video view, if video is not disabled.

    Declaration
    public virtual TView View { get; }
    Property Value
    Type Description
    TView

    ViewSink

    Gets the video view sink, if video is not disabled.

    Declaration
    public ViewSink<TView> ViewSink { get; }
    Property Value
    Type Description
    ViewSink<TView>

    Vp8Controller

    Gets the first VP8 controller.

    Declaration
    public VideoPipe Vp8Controller { get; }
    Property Value
    Type Description
    VideoPipe

    Vp8Controllers

    Gets the VP8 controllers.

    Declaration
    public VideoPipe[] Vp8Controllers { get; }
    Property Value
    Type Description
    VideoPipe[]

    Vp8Converter

    Gets the first VP8 converter.

    Declaration
    public VideoPipe Vp8Converter { get; }
    Property Value
    Type Description
    VideoPipe

    Vp8Converters

    Gets the VP8 converters.

    Declaration
    public VideoPipe[] Vp8Converters { get; }
    Property Value
    Type Description
    VideoPipe[]

    Vp8Disabled

    Gets whether the VP8 codec is disabled.

    Declaration
    public bool Vp8Disabled { get; }
    Property Value
    Type Description
    System.Boolean

    Vp8Encoder

    Gets the first VP8 encoder.

    Declaration
    public VideoEncoder Vp8Encoder { get; }
    Property Value
    Type Description
    VideoEncoder

    Vp8Encoders

    Gets the VP8 encoders.

    Declaration
    public VideoEncoder[] Vp8Encoders { get; }
    Property Value
    Type Description
    VideoEncoder[]

    Vp8Packetizer

    Gets the first VP8 packetizer.

    Declaration
    public VideoPipe Vp8Packetizer { get; }
    Property Value
    Type Description
    VideoPipe

    Vp8Packetizers

    Gets the VP8 packetizers.

    Declaration
    public VideoPipe[] Vp8Packetizers { get; }
    Property Value
    Type Description
    VideoPipe[]

    Vp9Controller

    Gets the first VP9 controller.

    Declaration
    public VideoPipe Vp9Controller { get; }
    Property Value
    Type Description
    VideoPipe

    Vp9Controllers

    Gets the VP9 controllers.

    Declaration
    public VideoPipe[] Vp9Controllers { get; }
    Property Value
    Type Description
    VideoPipe[]

    Vp9Converter

    Gets the first VP9 converter.

    Declaration
    public VideoPipe Vp9Converter { get; }
    Property Value
    Type Description
    VideoPipe

    Vp9Converters

    Gets the VP9 converters.

    Declaration
    public VideoPipe[] Vp9Converters { get; }
    Property Value
    Type Description
    VideoPipe[]

    Vp9Disabled

    Gets whether the VP9 codec is disabled.

    Declaration
    public bool Vp9Disabled { get; }
    Property Value
    Type Description
    System.Boolean

    Vp9Encoder

    Gets the first VP9 encoder.

    Declaration
    public VideoEncoder Vp9Encoder { get; }
    Property Value
    Type Description
    VideoEncoder

    Vp9Encoders

    Gets the VP9 encoders.

    Declaration
    public VideoEncoder[] Vp9Encoders { get; }
    Property Value
    Type Description
    VideoEncoder[]

    Vp9Packetizer

    Gets the first VP9 packetizer.

    Declaration
    public VideoPipe Vp9Packetizer { get; }
    Property Value
    Type Description
    VideoPipe

    Vp9Packetizers

    Gets the VP9 packetizers.

    Declaration
    public VideoPipe[] Vp9Packetizers { get; }
    Property Value
    Type Description
    VideoPipe[]

    Methods

    CreateAudioRecorder(AudioFormat)

    Creates an audio recorder.

    Declaration
    protected abstract AudioSink CreateAudioRecorder(AudioFormat inputFormat)
    Parameters
    Type Name Description
    AudioFormat inputFormat

    The input format.

    Returns
    Type Description
    AudioSink

    CreateAudioSource(AudioConfig)

    Creates an audio source.

    Declaration
    protected abstract AudioSource CreateAudioSource(AudioConfig config)
    Parameters
    Type Name Description
    AudioConfig config

    The configuration.

    Returns
    Type Description
    AudioSource

    CreateFrameRateController(VideoFormat)

    Creates a frame-rate controller.

    Declaration
    protected virtual VideoPipe CreateFrameRateController(VideoFormat outputFormat)
    Parameters
    Type Name Description
    VideoFormat outputFormat

    The video output format.

    Returns
    Type Description
    VideoPipe

    CreateG722Encoder(AudioConfig)

    Creates a G.722 encoder.

    Declaration
    protected virtual AudioEncoder CreateG722Encoder(AudioConfig config)
    Parameters
    Type Name Description
    AudioConfig config

    The configuration.

    Returns
    Type Description
    AudioEncoder

    CreateG722Packetizer(AudioConfig)

    Creates a G.722 packetizer.

    Declaration
    protected virtual AudioPipe CreateG722Packetizer(AudioConfig config)
    Parameters
    Type Name Description
    AudioConfig config

    The configuration.

    Returns
    Type Description
    AudioPipe

    CreateH264Encoder()

    Creates an H.264 encoder.

    Declaration
    protected abstract VideoEncoder CreateH264Encoder()
    Returns
    Type Description
    VideoEncoder

    CreateH264Encoders()

    Creates H.264 encoders.

    Declaration
    protected virtual VideoEncoder[] CreateH264Encoders()
    Returns
    Type Description
    VideoEncoder[]

    CreateH264Packetizer()

    Creates an H.264 packetizer.

    Declaration
    protected virtual VideoPipe CreateH264Packetizer()
    Returns
    Type Description
    VideoPipe

    CreateH264Packetizers()

    Creates H.264 packetizers.

    Declaration
    protected virtual VideoPipe[] CreateH264Packetizers()
    Returns
    Type Description
    VideoPipe[]

    CreateH265Encoder()

    Creates a H.265 encoder.

    Declaration
    protected virtual VideoEncoder CreateH265Encoder()
    Returns
    Type Description
    VideoEncoder

    CreateH265Packetizer()

    Creates a H.265 packetizer.

    Declaration
    protected virtual VideoPipe CreateH265Packetizer()
    Returns
    Type Description
    VideoPipe

    CreateImageConverter(VideoFormat)

    Creates an image converter.

    Declaration
    protected abstract VideoPipe CreateImageConverter(VideoFormat outputFormat)
    Parameters
    Type Name Description
    VideoFormat outputFormat

    The video output format.

    Returns
    Type Description
    VideoPipe

    CreateL16Encoder(AudioConfig)

    Creates a L16 encoder.

    Declaration
    protected virtual AudioEncoder CreateL16Encoder(AudioConfig config)
    Parameters
    Type Name Description
    AudioConfig config

    The configuration.

    Returns
    Type Description
    AudioEncoder

    CreateL16Packetizer(AudioConfig)

    Creates a L16 packetizer.

    Declaration
    protected virtual AudioPipe CreateL16Packetizer(AudioConfig config)
    Parameters
    Type Name Description
    AudioConfig config

    The configuration.

    Returns
    Type Description
    AudioPipe

    CreateOpusEncoder(AudioConfig)

    Creates an Opus encoder.

    Declaration
    protected abstract AudioEncoder CreateOpusEncoder(AudioConfig config)
    Parameters
    Type Name Description
    AudioConfig config

    The configuration.

    Returns
    Type Description
    AudioEncoder

    CreateOpusPacketizer(AudioConfig)

    Creates an Opus packetizer.

    Declaration
    protected virtual AudioPipe CreateOpusPacketizer(AudioConfig config)
    Parameters
    Type Name Description
    AudioConfig config

    The configuration.

    Returns
    Type Description
    AudioPipe

    CreatePcmaEncoder(AudioConfig)

    Creates a PCMA encoder.

    Declaration
    protected virtual AudioEncoder CreatePcmaEncoder(AudioConfig config)
    Parameters
    Type Name Description
    AudioConfig config

    The configuration.

    Returns
    Type Description
    AudioEncoder

    CreatePcmaPacketizer(AudioConfig)

    Creates a PCMA packetizer.

    Declaration
    protected virtual AudioPipe CreatePcmaPacketizer(AudioConfig config)
    Parameters
    Type Name Description
    AudioConfig config

    The configuration.

    Returns
    Type Description
    AudioPipe

    CreatePcmuEncoder(AudioConfig)

    Creates a PCMU encoder.

    Declaration
    protected virtual AudioEncoder CreatePcmuEncoder(AudioConfig config)
    Parameters
    Type Name Description
    AudioConfig config

    The configuration.

    Returns
    Type Description
    AudioEncoder

    CreatePcmuPacketizer(AudioConfig)

    Creates a PCMU packetizer.

    Declaration
    protected virtual AudioPipe CreatePcmuPacketizer(AudioConfig config)
    Parameters
    Type Name Description
    AudioConfig config

    The configuration.

    Returns
    Type Description
    AudioPipe

    CreateSoundConverter(AudioConfig)

    Creates a sound converter.

    Declaration
    protected virtual AudioPipe CreateSoundConverter(AudioConfig config)
    Parameters
    Type Name Description
    AudioConfig config

    The configuration.

    Returns
    Type Description
    AudioPipe

    CreateVideoRecorder(VideoFormat)

    Creates a video recorder.

    Declaration
    protected abstract VideoSink CreateVideoRecorder(VideoFormat inputFormat)
    Parameters
    Type Name Description
    VideoFormat inputFormat

    The output format.

    Returns
    Type Description
    VideoSink

    CreateVideoSource()

    Creates a video source.

    Declaration
    protected abstract VideoSource CreateVideoSource()
    Returns
    Type Description
    VideoSource

    CreateViewSink()

    Creates a view sink.

    Declaration
    protected abstract ViewSink<TView> CreateViewSink()
    Returns
    Type Description
    ViewSink<TView>

    CreateVp8Encoder()

    Creates a VP8 encoder.

    Declaration
    protected abstract VideoEncoder CreateVp8Encoder()
    Returns
    Type Description
    VideoEncoder

    CreateVp8Packetizer()

    Creates a VP8 packetizer.

    Declaration
    protected virtual VideoPipe CreateVp8Packetizer()
    Returns
    Type Description
    VideoPipe

    CreateVp9Encoder()

    Creates a VP9 encoder.

    Declaration
    protected abstract VideoEncoder CreateVp9Encoder()
    Returns
    Type Description
    VideoEncoder

    CreateVp9Packetizer()

    Creates a VP9 packetizer.

    Declaration
    protected virtual VideoPipe CreateVp9Packetizer()
    Returns
    Type Description
    VideoPipe

    Destroy()

    Destroys all media tracks.

    Declaration
    public override void Destroy()
    Overrides
    FM.LiveSwitch.Media<FM.LiveSwitch.AudioTrack, FM.LiveSwitch.VideoTrack>.Destroy()

    DoGetAudioEncodings()

    Gets the local audio encodings.

    Declaration
    protected override AudioEncodingConfig[] DoGetAudioEncodings()
    Returns
    Type Description
    AudioEncodingConfig[]

    The local audio encodings.

    Overrides
    LocalMedia.DoGetAudioEncodings()

    DoGetVideoEncodings()

    Gets the local video encodings.

    Declaration
    protected override VideoEncodingConfig[] DoGetVideoEncodings()
    Returns
    Type Description
    VideoEncodingConfig[]

    The local video encodings.

    Overrides
    LocalMedia.DoGetVideoEncodings()

    DoSetAudioEncodings(AudioEncodingConfig[])

    Sets the local audio encodings.

    Declaration
    protected override void DoSetAudioEncodings(AudioEncodingConfig[] encodings)
    Parameters
    Type Name Description
    AudioEncodingConfig[] encodings

    The local audio encodings.

    Overrides
    LocalMedia.DoSetAudioEncodings(AudioEncodingConfig[])

    DoSetVideoEncodings(VideoEncodingConfig[])

    Sets the local video encodings.

    Declaration
    protected override void DoSetVideoEncodings(VideoEncodingConfig[] encodings)
    Parameters
    Type Name Description
    VideoEncodingConfig[] encodings

    The local video encodings.

    Overrides
    LocalMedia.DoSetVideoEncodings(VideoEncodingConfig[])

    Initialize()

    Initializes this instance. Must be called before being used.

    Declaration
    public bool Initialize()
    Returns
    Type Description
    System.Boolean

    Initialize(RtcAudioTrackConfig, RtcVideoTrackConfig)

    Initializes this instance. Must be called before being used.

    Declaration
    public bool Initialize(RtcAudioTrackConfig audioTrackConfig, RtcVideoTrackConfig videoTrackConfig)
    Parameters
    Type Name Description
    RtcAudioTrackConfig audioTrackConfig
    RtcVideoTrackConfig videoTrackConfig
    Returns
    Type Description
    System.Boolean

    ToggleAudioRecording()

    Toggles audio recording.

    Declaration
    public bool ToggleAudioRecording()
    Returns
    Type Description
    System.Boolean

    ToggleVideoRecording()

    Toggles video recording.

    Declaration
    public bool ToggleVideoRecording()
    Returns
    Type Description
    System.Boolean

    Events

    OnActiveAudioConverterChange

    Raised when the ActiveAudioConverter changes.

    Declaration
    public event Action1<AudioPipe> OnActiveAudioConverterChange
    Event Type
    Type Description
    Action1<AudioPipe>

    OnActiveAudioEncoderChange

    Raised when the ActiveAudioEncoder changes.

    Declaration
    public event Action1<AudioEncoder> OnActiveAudioEncoderChange
    Event Type
    Type Description
    Action1<AudioEncoder>

    OnActiveAudioPacketizerChange

    Raised when the ActiveAudioPacketizer changes.

    Declaration
    public event Action1<AudioPipe> OnActiveAudioPacketizerChange
    Event Type
    Type Description
    Action1<AudioPipe>

    OnActiveVideoControllerChange

    Raised when the ActiveVideoController changes.

    Declaration
    public event Action1<VideoPipe> OnActiveVideoControllerChange
    Event Type
    Type Description
    Action1<VideoPipe>

    OnActiveVideoConverterChange

    Raised when the ActiveVideoConverter changes.

    Declaration
    public event Action1<VideoPipe> OnActiveVideoConverterChange
    Event Type
    Type Description
    Action1<VideoPipe>

    OnActiveVideoEncoderChange

    Raised when the ActiveVideoEncoder changes.

    Declaration
    public event Action1<VideoEncoder> OnActiveVideoEncoderChange
    Event Type
    Type Description
    Action1<VideoEncoder>

    OnActiveVideoPacketizerChange

    Raised when the ActiveVideoPacketizer changes.

    Declaration
    public event Action1<VideoPipe> OnActiveVideoPacketizerChange
    Event Type
    Type Description
    Action1<VideoPipe>

    Implements

    ILocalMedia<TLocalMedia, TIAudioTrack, TIVideoTrack>
    IMedia<TIAudioTrack, TIVideoTrack>
    IViewSinkableMedia<TView, TViewSink>
    IViewableMedia<TView>
    In This Article
    Back to top Copyright © LiveSwitch Inc. All Rights Reserved. Doc build for LiveSwitch v1.19.0