Class AudioOffload

Definition

Namespace:
Tizen.Multimedia
Assembly:
Tizen.Multimedia.MediaPlayer.dll
API Level:
6

The class that control the audio offload for Player.

C#
Copy
public class AudioOffload
Inheritance
System.Object
AudioOffload

Properties

View Source

IsActivated

Get a state whether or not the audio offload is activated.

Declaration
C#
Copy
public bool IsActivated { get; }
Property Value
Type Description
Boolean

The value indicating whether or not AudioOffload is activated.

Remarks

Audio offload could be inactivated depending on the audio device capability even though the audio offload feature is supported. The Player that owns this instance must be in the Ready, Playing, or Paused state.

Exceptions
Type Condition
System.NotSupportedException

The required feature is not supported.

ObjectDisposedException

The player has already been disposed of.

System.InvalidOperationException

The player is not in the valid state.
-or-
Operation failed; internal error.

API Level: 6
Feature: http://tizen.org/feature/multimedia.player.audio_offload
View Source

IsEnabled

Enables or disables the audio offload.

Declaration
C#
Copy
public bool IsEnabled { get; set; }
Property Value
Type Description
Boolean

The value indicating whether or not audio offload is enabled. The default value is false.

Remarks

The player lets the hardware decode and render the sound if the audio offload is enabled. Audio offload can reduce the power consumption, but disable the ability to handle output PCM. Please check the below list of functions which will not work if offloading is enabled.

If audio offload is enabled, the following functions will return NotAvailableException:
AudioEffect
EqualizerBand
PlayerTrackInfo
EnableExportingAudioData(AudioMediaFormat, PlayerAudioExtractOption)
AudioLatencyMode
SetPlaybackRate(Single)
ReplayGain
AudioPitch
AudioPitchEnabled

Although they are called before offload is enabled, they don't work normally.

To set, the player must be in the Idle state. The sound stream type of the player should be Media.

Exceptions
Type Condition
System.NotSupportedException

The required feature is not supported.

ObjectDisposedException

The player has already been disposed of.

System.InvalidOperationException

The player is not in the valid state.
-or-
Operation failed; internal error.

API Level: 6
Feature: http://tizen.org/feature/multimedia.player.audio_offload
View Source

SupportedFormats

Retrieves the supported audio formats for audio offload.

Declaration
C#
Copy
public IEnumerable<MediaFormatAudioMimeType> SupportedFormats { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<MediaFormatAudioMimeType>

It returns a list containing supported audio formats for audio offload.

Remarks

The supported media format can vary depending on the device capabilities.

Exceptions
Type Condition
System.NotSupportedException

The required feature is not supported.

ObjectDisposedException

The Player has already been disposed of.

System.InvalidOperationException

Operation failed; internal error.

API Level: 6
Feature: http://tizen.org/feature/multimedia.player.audio_offload