Interface IEncoderTextInfo

Namespace

VisioForge.Core.Types.X

Assembly

VisioForge.Core.dll

Defines an interface for components that can provide textual information about encoder parameters and capabilities. This is useful for debugging, logging, or displaying detailed encoder settings to the user.

public interface IEncoderTextInfo

Examples

// Assume 'encoderSettings' is an instance of a class implementing IEncoderTextInfo.
IEncoderTextInfo encoderInfo = GetEncoderSettingsInstance();

if (encoderInfo != null)
{
    Console.WriteLine($"Encoder Parameters: {encoderInfo.GetParameters()}");
    Console.WriteLine($"Encoder Capabilities (Caps): {encoderInfo.GetCaps()}");
}

Remarks

Implementations of this interface are typically found in encoder configuration classes within the MediaBlocks framework. It allows for a standardized way to retrieve human-readable descriptions of complex encoder settings.

Methods

GetCaps()

Retrieves a string representation of the encoder's capabilities (GStreamer caps). This string describes the media formats and properties that the encoder can handle.

string GetCaps()

Returns

string

A String containing the encoder's capabilities.

GetParameters()

Retrieves a string representation of the encoder's current parameters. This string typically includes settings like bitrate, resolution, frame rate, and other configured options.

string GetParameters()

Returns

string

A String containing the encoder parameters.