Class MediaCodec

Definition

Namespace:: Tizen.Multimedia.MediaCodec

Assembly:: Tizen.Multimedia.MediaCodec.dll

Provides a means to encode and decode the video and the audio data.


                C#
                
                    Copy
                    
                
            
public class MediaCodec : IDisposable

Inheritance: object

MediaCodec

Implements: System.IDisposable

Constructors

View Source

MediaCodec()

Initializes a new instance of the MediaCodec class.

Declaration


                C#
                
                    Copy
                    
                
            
public MediaCodec()

Exceptions

Type	Condition
System.NotSupportedException	The required feature is not supported.

Properties

View Source

SupportedAudioCodecs

Gets the audio codec list that the current device supports.

Declaration


                C#
                
                    Copy
                    
                
            
public static IEnumerable<MediaFormatAudioMimeType> SupportedAudioCodecs { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<T><MediaFormatAudioMimeType>

View Source

SupportedVideoCodecs

Gets the audio codec list that the current device supports.

Declaration


                C#
                
                    Copy
                    
                
            
public static IEnumerable<MediaFormatVideoMimeType> SupportedVideoCodecs { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<T><MediaFormatVideoMimeType>

Methods

View Source

Configure(MediaFormat, bool, MediaCodecTypes)

Configures the MediaCodec.

Declaration


                C#
                
                    Copy
                    
                
            
public void Configure(MediaFormat format, bool encoder, MediaCodecTypes codecType)

Parameters

Type	Name	Description
MediaFormat	format	The MediaFormat for properties of media data to decode or encode.
bool	encoder	The value indicating whether the codec works as an encoder or a decoder.
MediaCodecTypes	codecType	The value indicating whether the codec uses hardware acceleration.

Exceptions

Type	Condition
System.NotSupportedException	The required feature is not supported.
System.ArgumentNullException	`format` is null.
System.ArgumentException	`codecType` is invalid. -or- `format` is neither audio type nor video type.
System.NotSupportedException	The mime type of the format is not supported.

View Source

Dispose()

Releases all resources used by the MediaCodec object.

Declaration


                C#
                
                    Copy
                    
                
            
public void Dispose()

View Source

Dispose(bool)

Releases the resources used by the MediaCodec object.

Declaration


                C#
                
                    Copy
                    
                
            
protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing	true to release both managed and unmanaged resources; false to release only unmanaged resources.

View Source

~MediaCodec()

Finalizes an instance of the MediaCodec class.

Declaration


                C#
                
                    Copy
                    
                
            
protected ~MediaCodec()

View Source

FlushBuffers()

Flushes both input and output buffers.

Declaration


                C#
                
                    Copy
                    
                
            
public void FlushBuffers()

Exceptions

Type	Condition
System.NotSupportedException	The required feature is not supported.

View Source

GetCodecType(bool, MediaFormatAudioMimeType)

Retrieves supported codec types for the specified params.

Declaration


                C#
                
                    Copy
                    
                
            
public MediaCodecTypes GetCodecType(bool encoder, MediaFormatAudioMimeType type)

Parameters

Type	Name	Description
bool	encoder	The value indicating encoder or decoder.
MediaFormatAudioMimeType	type	The mime type to query.

Returns

Type	Description
MediaCodecTypes	The values indicating which codec types are supported on the current device.

Exceptions

Type	Condition
System.NotSupportedException	The required feature is not supported.
System.ArgumentException	`type` is invalid.

View Source

GetCodecType(bool, MediaFormatVideoMimeType)

Retrieves supported codec types for the specified params.

Declaration


                C#
                
                    Copy
                    
                
            
public MediaCodecTypes GetCodecType(bool encoder, MediaFormatVideoMimeType type)

Parameters

Type	Name	Description
bool	encoder	The value indicating encoder or decoder.
MediaFormatVideoMimeType	type	The mime type to query.

Returns

Type	Description
MediaCodecTypes	The values indicating which codec types are supported on the current device.

Exceptions

Type	Condition
System.NotSupportedException	The required feature is not supported.
System.ArgumentException	`type` is invalid.

View Source

Prepare()

Prepares the MediaCodec for encoding or decoding.

Declaration


                C#
                
                    Copy
                    
                
            
public void Prepare()

Exceptions

Type	Condition
System.NotSupportedException	The required feature is not supported.
System.InvalidOperationException	The codec is not configured yet. -or- Internal error.

View Source

ProcessInput(MediaPacket)

Adds the packet to the internal queue of the codec.

Declaration


                C#
                
                    Copy
                    
                
            
public void ProcessInput(MediaPacket packet)

Parameters

Type	Name	Description
MediaPacket	packet	The packet to be encoded or decoded.

Remarks

Any attempts to modify the packet will fail until the InputProcessed event for the packet is invoked.

Exceptions

Type	Condition
System.NotSupportedException	The required feature is not supported.
System.ArgumentNullException	`packet` is null.
System.InvalidOperationException	The current codec is not prepared yet.

View Source

Unprepare()

Unprepares the MediaCodec.

Declaration


                C#
                
                    Copy
                    
                
            
public void Unprepare()

Exceptions

Type	Condition
System.NotSupportedException	The required feature is not supported.

Events

View Source

BufferStatusChanged

Occurs when the codec needs more data or has enough data.

Declaration


                C#
                
                    Copy
                    
                
            
public event EventHandler<BufferStatusChangedEventArgs> BufferStatusChanged

Event Type

Type	Description
System.EventHandler<TEventArgs><BufferStatusChangedEventArgs>

View Source

EosReached

Occurs when the codec processes all input data.

Declaration


                C#
                
                    Copy
                    
                
            
public event EventHandler<EventArgs> EosReached

Event Type

Type	Description
System.EventHandler<TEventArgs><System.EventArgs>

View Source

ErrorOccurred

Occurs whenever an error is produced in the codec.

Declaration


                C#
                
                    Copy
                    
                
            
public event EventHandler<MediaCodecErrorOccurredEventArgs> ErrorOccurred

Event Type

Type	Description
System.EventHandler<TEventArgs><MediaCodecErrorOccurredEventArgs>

View Source

InputProcessed

Occurs when an input packet is processed.

Declaration


                C#
                
                    Copy
                    
                
            
public event EventHandler<InputProcessedEventArgs> InputProcessed

Event Type

Type	Description
System.EventHandler<TEventArgs><InputProcessedEventArgs>

View Source

OutputAvailable

Occurs when an output buffer is available.

Declaration


                C#
                
                    Copy
                    
                
            
public event EventHandler<OutputAvailableEventArgs> OutputAvailable

Event Type

Type	Description
System.EventHandler<TEventArgs><OutputAvailableEventArgs>

Remarks

The output packet needs to be disposed after it is used to clean up unmanaged resources.

Implements

System.IDisposable