Click or drag to resize

Encoder Class
A libopus-based encoder.
Inheritance Hierarchy

Namespace:  FM.IceLink.Opus
Assembly:  FM.IceLink.Opus (in FM.IceLink.Opus.dll) Version: 1.1.2.607 (1.1.2.607)

The Encoder type exposes the following members.

Constructors
  NameDescription
Public methodEncoder
Initializes a new instance of the Encoder class.
Public methodEncoder(AudioConfig)
Initializes a new instance of the Encoder class.
Public methodEncoder(IAudioOutput)
Initializes a new instance of the Encoder class.
Top
Properties
  NameDescription
Protected propertyAllowDiagnosticTimer
Gets whether this media pipe is allowed to be timed.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Public propertyBitrate
Gets or sets encoder bitrate. Getting this value retrieves the current bitrate, whereas setting it sets the target bitrate for the encoder.
Public propertyCodecConfig
Gets a copy of the encoder codec's config.
Public propertyConfig
Gets the output configuration. (Alias for OutputConfig.)
(Inherited from AudioPipe.)
Public propertyDisabled
Gets a value indicating whether this pipe is disabled.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Public propertyDisableFec
Gets or sets a value indicating whether FEC is disabled.
Public propertyDynamicProperties
Gets or sets the dynamic properties on this instance.
(Inherited from Dynamic.)
Public propertyFramesEncoded
Gets the number of encoded frames.
(Inherited from AudioEncoder.)
Public propertyGain
Gets or sets a value indicating the gain (input amplification) of this sink. Any value greater than or equal to 0.0 is acceptable.
(Inherited from AudioPipe.)
Public propertyId
Gets or sets the identifier.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Public propertyInput
Gets or sets the input.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Public propertyInputConfig
Gets the input configuration.
(Inherited from AudioPipe.)
Public propertyInputFormat
Gets the input format.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Public propertyInputs
Gets or sets the inputs.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Protected propertyIsDirty
Gets or sets a value indicating whether this instance is dirty.
(Inherited from Serializable.)
Public propertyLabel
Gets a label that identifies this class.
(Overrides MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormatLabel.)
Public propertyMaxInputBitrate
Gets -1.
(Inherited from AudioEncoder.)
Public propertyMaxOutputBitrate
Gets the maximum bitrate this encoder will produce, based on the encoder's target bitrate and the MaxInputBitrate of its' sinks.
(Overrides MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormatMaxOutputBitrate.)
Public propertyMuted
Gets or sets a value indicating whether this instance is muted.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Public propertyOutput
Gets or sets the output.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Public propertyOutputConfig
Gets the output configuration.
(Inherited from AudioPipe.)
Public propertyOutputFormat
Gets the output format.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Public propertyOutputs
Gets or sets the outputs.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Public propertyPercentLossToTriggerFEC
Gets or sets the loss percentage (0-100) before forward error correction (FEC) is activated (only if supported by the remote peer). Affects encoded data only.
Public propertyPersistent
Gets or sets a value indicating whether this instance is persistent. If true, this instance will not be destroyed unless Destroy is called explicitly on this instance. It will survive destruction of any parent elements that are being destroyed.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Public propertyPipelineJson
Gets the pipeline JSON with this as the central point.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Protected propertyPipelineJsonBase
Gets the pipeline JSON base.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Public propertyPipelineJsonFromInput
Gets the pipeline JSON from an input.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Public propertyPipelineJsonFromOutput
Gets the pipeline JSON from an output.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Protected propertyPipelineJsonInputs
Gets the pipeline JSON inputs.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Protected propertyPipelineJsonOutputs
Gets the pipeline JSON outputs.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Public propertyProcessFramePolicy
Gets or sets the ProcessFramePolicy for this media input.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Public propertyQuality
Gets or sets the quality.
Public propertyState
Gets the state.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Public propertyTag
Gets or sets an optional tag to identify this instance.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Public propertyVolume
Gets or sets a value indicating the volume (output resistance) of this source. Valid value range is 0.0 to 1.0, inclusive.
(Inherited from AudioPipe.)
Top
Methods
  NameDescription
Public methodAddInput
Adds an input.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Public methodAddInputs
Adds some inputs.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Public methodAddOutput
Adds an output.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Public methodAddOutputs
Adds some outputs.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Protected methodCreateInputCollection
Creates an input collection.
(Inherited from AudioPipe.)
Protected methodCreateOutputCollection
Creates an output collection.
(Inherited from AudioPipe.)
Public methodDestroy
Destroys this instance.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Protected methodDoDestroy
Destroys this instance.
(Overrides MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormatDoDestroy.)
Protected methodDoProcessControlFrames
Processes the control frames.
(Overrides MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormatDoProcessControlFrames(MediaControlFrame).)
Protected methodDoProcessFrame
Processes a frame.
(Overrides MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormatDoProcessFrame(TFrame, TBuffer).)
Protected methodDoProcessSdpMediaDescription
Processes a SDP media description.
(Overrides MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormatDoProcessSdpMediaDescription(MediaDescription, Boolean, Boolean).)
Protected methodDoProcessStatsFromInput
Processes stats from an input.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Protected methodDoProcessStatsFromOutput
Processes stats from an output.
(Inherited from AudioEncoder.)
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetDynamicValue
Gets a property value from the local cache.
(Inherited from Dynamic.)
Public methodGetFirSequenceNumber
Gets the FIR sequence number.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodHasInput
Determines whether this pipe has the specified input.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Public methodHasOutput
Determines whether this pipe has the specified output.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Public methodIncrementFirSequenceNumber
Increments the FIR sequence number.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodProcessControlFrames
Processes the control frames.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Public methodProcessFrame
Processes a frame.
(Inherited from AudioPipe.)
Public methodProcessGetMuteFromStream
Gets whether the stream is muted or not.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Public methodProcessSdpMediaDescriptionFromInput
Processes an SDP media description from an input.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Public methodProcessSdpMediaDescriptionFromOutput
Processes an SDP media description from an output.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Public methodProcessSetMuteFromStream
Process a set mute call from a stream.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Public methodProcessStatsFromInput
Processes stats from an input.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Public methodProcessStatsFromOutput
Processes stats from an output.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Protected methodRaiseControlFrame
Raises a control frame.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Protected methodRaiseControlFrames
Raises some control frames.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Protected methodRaiseFrame
Raises the frame.
(Inherited from AudioEncoder.)
Public methodRemoveInput
Removes an input.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Public methodRemoveInputs
Removes all inputs.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Public methodRemoveInputs(TIOutput)
Removes some inputs.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Public methodRemoveOutput
Removes an output.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Public methodRemoveOutputs
Removes all outputs.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Public methodRemoveOutputs(TIInput)
Removes some outputs.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Public methodSetCodecConfig
Sets the encoder configuration.
Public methodSetDynamicValue
Sets a property value in the local cache.
(Inherited from Dynamic.)
Public methodToString
Returns a string that represents this instance.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Public methodUnsetDynamicValue
Unsets a property value in the local cache.
(Inherited from Dynamic.)
Top
Events
  NameDescription
Public eventOnDisabledChange
Raised when the Disabled property changes state.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Public eventOnProcessControlFrames
Raised when control frames are processed.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Public eventOnProcessFrame
Raised when a frame is processed.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Public eventOnProcessFrameException
Raised when an exception is thrown while processing a frame.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Public eventOnRaiseControlFrames
Raised when control frames are raised.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Public eventOnRaiseFrame
Raised when a frame is raised.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Public eventOnStateChange
Raised when the state changes.
(Inherited from MediaPipeTIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat.)
Top
Version Information

IceLink Xamarin

Supported in: 3.0.3.48
See Also