Class Player

Definition

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

Provides the ability to control media playback.

public class Player : IDisposable
Inheritance
Object
Player
Implements
IDisposable
Remarks

The player provides functions to play a media content. It also provides functions to adjust the configurations of the player such as playback rate, volume, looping etc. Note that only one video player can be played at one time.

Constructors

View Source

Player()

Initializes a new instance of the Player class.

Declaration
public Player()
API Level: 3

Properties

View Source

AdaptiveVariants

Gets the adaptive variants settings.

Declaration
public AdaptiveVariants AdaptiveVariants { get; }
Property Value
Type Description
AdaptiveVariants
API Level: 5
View Source

AudioCodecType

Gets or sets the default codec type of the audio decoder.

Declaration
public CodecType AudioCodecType { get; set; }
Property Value
Type Description
CodecType

A CodecType specifies the type. The default codec type could be different depending on the device capability.
Remarks

To set, the player must be in the Idle state.

If H/W audio codec type is not supported in some cases, S/W audio codec type could be used instead.

The availability could be changed depending on the codec capability. If an application wants to use the H/W audio codec type as default, The following functions should be called after the codec type is set. :
IsAvailable
EnableExportingAudioData(AudioMediaFormat, PlayerAudioExtractOption)
DisableExportingAudioData()
ReplayGain
AudioPitch
AudioPitchEnabled

Exceptions
Type Condition
ObjectDisposedException

The player has already been disposed of.
ArgumentException

The value is not valid.
InvalidOperationException

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

The selected codec is not supported.
API Level: 6
View Source

AudioEffect

Gets the audio effect.

Declaration
public AudioEffect AudioEffect { get; }
Property Value
Type Description
AudioEffect
Exceptions
Type Condition
NotSupportedException

The required feature is not supported.
API Level: 3
Feature: http://tizen.org/feature/multimedia.custom_audio_effect
View Source

AudioLatencyMode

Gets or sets the audio latency mode.

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

A AudioLatencyMode that specifies the mode. The default is Mid.
Remarks

If the mode is High, audio output interval can be increased, so it can keep more audio data to play. But, state transition like pause or resume can be more slower than default(Mid).

Exceptions
Type Condition
ObjectDisposedException

The player has already been disposed of.
ArgumentException

The value is not valid.
NotAvailableException

If audio offload is enabled by calling IsEnabled. (Since tizen 6.0)
See Also
API Level: 3
View Source

AudioOffload

Gets the setting for audio offload.

Declaration
public AudioOffload AudioOffload { get; }
Property Value
Type Description
AudioOffload
API Level: 6
View Source

AudioPitch

Gets or sets the pitch of audio.

Declaration
public float AudioPitch { get; set; }
Property Value
Type Description
Single

The audio stream pitch value. The default is 1.
Remarks

Enabling pitch control could increase the CPU usage on some devices. This function is used for audio content only. This function could be unavailable depending on the audio codec type.

Exceptions
Type Condition
InvalidOperationException

A pitch is not enabled.
ObjectDisposedException

The player has already been disposed of.
ArgumentOutOfRangeException

value is less than 0.5. -or-
value is greater than 2.0.
NotAvailableException

If audio offload is enabled by calling IsEnabled. (Since tizen 6.0) -or-
The function is not available depending on the audio codec type. (Since tizen 6.0)
See Also
API Level: 6
View Source

AudioPitchEnabled

Enables or disables controlling the pitch of audio. Gets the status of controlling the pitch of audio.

Declaration
public bool AudioPitchEnabled { get; set; }
Property Value
Type Description
Boolean

The value indicating whether or not AudioPitch is enabled. The default is false.
Remarks

This function is used for audio content only. To set, the player must be in the Idle state. This function could be unavailable depending on the audio codec type.

Exceptions
Type Condition
InvalidOperationException

The player is not in the valid state.
ObjectDisposedException

The player has already been disposed of.
NotAvailableException

If audio offload is enabled by calling IsEnabled. (Since tizen 6.0) -or-
The function is not available depending on the audio codec type. (Since tizen 6.0)
See Also
API Level: 6
View Source

AudioTrackInfo

Gets the track info for the audio.

Declaration
public PlayerTrackInfo AudioTrackInfo { get; }
Property Value
Type Description
PlayerTrackInfo

A PlayerTrackInfo for audio.
API Level: 3
View Source

BufferingTime

Gets or sets the streaming buffering time.

Declaration
public PlayerBufferingTime BufferingTime { get; set; }
Property Value
Type Description
PlayerBufferingTime
Remarks

To set, the player must be in the Idle state.

Exceptions
Type Condition
InvalidOperationException

The player is not in the valid state.
ObjectDisposedException

The player has already been disposed of.
ArgumentOutOfRangeException

is less than -1.
-or-
is less than -1.
NotSupportedException

The required feature is not supported.
See Also
API Level: 5
View Source

Gets or sets the cookie for streaming playback.

Declaration
public string Cookie { get; set; }
Property Value
Type Description
String

To set, the player must be in the Idle state.

Exceptions
Type Condition
InvalidOperationException

The player is not in the valid state.
ObjectDisposedException

The player has already been disposed of.
ArgumentNullException

The value to set is null.
API Level: 3
View Source

Display

Gets or sets the display.

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

A Display that specifies the display.
Remarks

The player must be in the Idle state.
The raw video feature(http://tizen.org/feature/multimedia.raw_video) is required if the display is created with MediaView.

Exceptions
Type Condition
ObjectDisposedException

The player has already been disposed of.
ArgumentException

The value has already been assigned to another player.
InvalidOperationException

The player is not in the valid state.
NotSupportedException

The required feature is not supported.
API Level: 3
View Source

DisplaySettings

Gets the display settings.

Declaration
public PlayerDisplaySettings DisplaySettings { get; }
Property Value
Type Description
PlayerDisplaySettings

A PlayerDisplaySettings that specifies the display settings.
API Level: 3
View Source

Handle

Gets the native handle of the player.

Declaration
public IntPtr Handle { get; }
Property Value
Type Description
IntPtr

An IntPtr that contains the native handle of the player.
Exceptions
Type Condition
ObjectDisposedException

The player has already been disposed of.
API Level: 3
View Source

IsAudioOnly

Gets or sets the audio-only state.

Declaration
public bool IsAudioOnly { get; set; }
Property Value
Type Description
Boolean

true if the playback is audio-only mode; otherwise, false. The default value is false.
Exceptions
Type Condition
InvalidOperationException

The player is not in the valid state.
ObjectDisposedException

The player has already been disposed of.
API Level: 5
View Source

IsLooping

Gets or sets the looping state.

Declaration
public bool IsLooping { get; set; }
Property Value
Type Description
Boolean

true if the playback is looping; otherwise, false. The default value is false.
Exceptions
Type Condition
ObjectDisposedException

The player has already been disposed of.
API Level: 3
View Source

Muted

Gets or sets the mute state.

Declaration
public bool Muted { get; set; }
Property Value
Type Description
Boolean

true if the player is muted; otherwise, false.
Exceptions
Type Condition
ObjectDisposedException

The player has already been disposed of.
API Level: 3
View Source

ReplayGain

Gets or sets the player's replaygain state.

Declaration
public bool ReplayGain { get; set; }
Property Value
Type Description
Boolean

If the replaygain status is true, replaygain is applied (if contents has a replaygain tag); otherwise, the replaygain is not affected by tag and properties.
Remarks

This function could be unavailable depending on the audio codec type.

Exceptions
Type Condition
ObjectDisposedException

The player has already been disposed of.
InvalidOperationException

The player is not in the valid state.
NotAvailableException

If audio offload is enabled by calling IsEnabled. (Since tizen 6.0) -or-
The function is not available depending on the audio codec type. (Since tizen 6.0)
See Also
API Level: 5
View Source

SphericalVideo

Gets the spherical video settings.

Declaration
public SphericalVideo SphericalVideo { get; }
Property Value
Type Description
SphericalVideo
API Level: 5
View Source

State

Gets the state of the player.

Declaration
public PlayerState State { get; }
Property Value
Type Description
PlayerState

The current state of the player.
Exceptions
Type Condition
ObjectDisposedException

The player has already been disposed of.
API Level: 3
View Source

StreamInfo

Gets the stream information.

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

A StreamInfo for this player.
API Level: 3
View Source

SubtitleTrackInfo

Gets the track info for the subtitle.

Declaration
public PlayerTrackInfo SubtitleTrackInfo { get; }
Property Value
Type Description
PlayerTrackInfo

A PlayerTrackInfo for the subtitle.
API Level: 3
View Source

UserAgent

Gets or sets the user agent for streaming playback.

Declaration
public string UserAgent { get; set; }
Property Value
Type Description
String
Remarks

To set, the player must be in the Idle state.

Exceptions
Type Condition
InvalidOperationException

The player is not in the valid state.
ObjectDisposedException

The player has already been disposed of.
ArgumentNullException

The value to set is null.
API Level: 3
View Source

Volume

Gets or sets the current volume.

Declaration
public float Volume { get; set; }
Property Value
Type Description
Single
Remarks

Valid volume range is from 0 to 1.0, inclusive.

Exceptions
Type Condition
ObjectDisposedException

The player has already been disposed of.
ArgumentOutOfRangeException

value is less than zero.
-or-
value is greater than 1.0.
API Level: 3

Methods

View Source

ApplyAudioStreamPolicy(AudioStreamPolicy)

Applies the audio stream policy.

Declaration
public void ApplyAudioStreamPolicy(AudioStreamPolicy policy)
Parameters
Type Name Description
AudioStreamPolicy policy

The AudioStreamPolicy to apply.
Remarks

The player must be in the Idle state.

Player does not support all AudioStreamType.
Supported types are Media, System, Alarm, Notification, Emergency, VoiceInformation, RingtoneVoip and MediaExternalOnly.

Exceptions
Type Condition
ObjectDisposedException

The player has already been disposed of.
-or-
policy has already been disposed of.
InvalidOperationException

The player is not in the valid state.
ArgumentNullException

policy is null.
NotSupportedException

The required feature is not supported.
-or-
AudioStreamType of policy is not supported on the current platform.
See Also
API Level: 3
Feature: http://tizen.org/feature/multimedia.player.stream_info
View Source

CaptureVideoAsync()

Captures a video frame, asynchronously.

Declaration
public Task<CapturedFrame> CaptureVideoAsync()
Returns
Type Description
Task<CapturedFrame>

A task that represents the asynchronous capture operation.
Remarks

The player must be in the Playing or Paused state.

Exceptions
Type Condition
ObjectDisposedException

The player has already been disposed of.
InvalidOperationException

The player is not in the valid state.
NotSupportedException

The required feature is not supported.
API Level: 3
Feature: http://tizen.org/feature/multimedia.raw_video
View Source

ClearSubtitle()

Removes the subtitle path.

Declaration
public void ClearSubtitle()
Remarks

The player must be in the Idle state.

Exceptions
Type Condition
ObjectDisposedException

The player has already been disposed of.
InvalidOperationException

The player is not in the valid state.
API Level: 3
View Source

DisableExportingAudioData()

Disable to decode an audio data.

Declaration
public void DisableExportingAudioData()
Remarks

The player must be in the Idle or Ready state. This function could be unavailable depending on the audio codec type.

Exceptions
Type Condition
ObjectDisposedException

The player has already been disposed of.
InvalidOperationException

The player is not in the valid state.
NotAvailableException

The function is not available depending on the audio codec type. (Since tizen 6.0)
See Also
API Level: 6
View Source

DisableExportingVideoFrame()

Disables to decode a video data.

Declaration
public void DisableExportingVideoFrame()
Remarks

The player must be in the Idle or Ready state.

Exceptions
Type Condition
NotSupportedException

The required feature is not supported.
ObjectDisposedException

The player has already been disposed of.
InvalidOperationException

The player is not in the valid state.
See Also
API Level: 6
Feature: http://tizen.org/feature/multimedia.raw_video
View Source

Dispose()

Releases all resources used by the current instance.

Declaration
public void Dispose()
API Level: 3
View Source

EnableExportingAudioData(AudioMediaFormat, PlayerAudioExtractOption)

Enable to decode an audio data for exporting PCM from a data.

Declaration
public void EnableExportingAudioData(AudioMediaFormat format, PlayerAudioExtractOption option)
Parameters
Type Name Description
AudioMediaFormat format

The media format handle required to audio PCM specification. The format has to include MimeType, Channel and SampleRate. If the format is NULL, the original PCM format or platform default PCM format will be applied.
PlayerAudioExtractOption option

The audio extract option.
Remarks

The player must be in the Idle state.

A AudioDataDecoded event is called in a separate thread(not in the main loop).

The audio PCM data can be retrieved using a AudioDataDecoded event as a media packet and it is available until it's destroyed by Dispose(). The packet has to be destroyed as quickly as possible after rendering the data and all the packets have to be destroyed before Unprepare() is called.

This function could be unavailable depending on the audio codec type.

Exceptions
Type Condition
ObjectDisposedException

The player has already been disposed of.
ArgumentException

The value is not valid.
InvalidOperationException

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

If audio offload is enabled by calling IsEnabled. (Since tizen 6.0) -or-
The function is not available depending on the audio codec type. (Since tizen 6.0)
See Also
API Level: 6
View Source

EnableExportingVideoFrame()

Enables to decode a video data for every frame.

Declaration
public void EnableExportingVideoFrame()
Remarks

The player must be in the Idle state, but Display must not be set.

A VideoFrameDecoded event is called in a separate thread, not called in the main loop.

The video frame can be retrieved using a VideoFrameDecoded event with a media packet parameter. If you change the media packet in the VideoFrameDecoded event, it will be displayed on the device. The callback function holds the same buffer that is drawn on the display device. and the MediaPacket is available until it is destroyed by Dispose(). It is recommended to destroy the packet as quickly as possible after the decoded data is rendered on the display. All the packets have to be destroyed before Unprepare() is called.

Exceptions
Type Condition
NotSupportedException

The required feature is not supported.
ObjectDisposedException

The player has already been disposed of.
InvalidOperationException

Operation failed; internal error. -or-
The player is not in the valid state.
See Also
API Level: 6
Feature: http://tizen.org/feature/multimedia.raw_video
View Source

GetDownloadProgress()

Gets the streaming download progress.

Declaration
public DownloadProgress GetDownloadProgress()
Returns
Type Description
DownloadProgress

The DownloadProgress containing current download progress.
Remarks

The player must be in the Ready, Playing, or Paused state.

Exceptions
Type Condition
InvalidOperationException

The player is not streaming.
-or-
The player is not in the valid state.
ObjectDisposedException

The player has already been disposed of.
API Level: 3
View Source

GetPlayPosition()

Gets the play position in milliseconds.

Declaration
public int GetPlayPosition()
Returns
Type Description
Int32

The current position in milliseconds.
Remarks

The player must be in the Ready, Playing, or Paused state.

Exceptions
Type Condition
ObjectDisposedException

The player has already been disposed of.
InvalidOperationException

The player is not in the valid state.
See Also
API Level: 3
View Source

GetPlayPositionNanoseconds()

Gets the play position in nanoseconds.

Declaration
public long GetPlayPositionNanoseconds()
Returns
Type Description
Int64

The current position in nanoseconds.
Remarks

The player must be in the Ready, Playing, or Paused state.

Exceptions
Type Condition
ObjectDisposedException

The player has already been disposed of.
InvalidOperationException

The player is not in the valid state.
See Also
API Level: 5
View Source

GetVideoRoi()

Get the relative ROI (Region Of Interest) area as a decimal fraction based on the video source.

Declaration
public ScaleRectangle GetVideoRoi()
Returns
Type Description
ScaleRectangle

The ScaleRectangle containing the ROI area information.
Remarks

The specified ROI area is valid only in Tizen.Multimedia.PlayerDisplayType.Overlay.

Exceptions
Type Condition
ObjectDisposedException

The player has already been disposed of.
InvalidOperationException

Operation failed; internal error.
See Also
API Level: 5
View Source

OnPreparing()

Called when the Tizen.Multimedia.Player.Prepare is invoked.

Declaration
protected virtual void OnPreparing()
API Level: 3
View Source

OnUnprepared()

Called after the Player is unprepared.

Declaration
protected virtual void OnUnprepared()
See Also
API Level: 3
View Source

Pause()

Pauses the player.

Declaration
public virtual void Pause()
Remarks

The player must be in the Playing state. It has no effect if the player is already in the Paused state.

Exceptions
Type Condition
ObjectDisposedException

The player has already been disposed of.
InvalidOperationException

The player is not in the valid state.
See Also
API Level: 3
View Source

PrepareAsync()

Prepares the media player for playback, asynchronously.

Declaration
public virtual Task PrepareAsync()
Returns
Type Description
Task

A task that represents the asynchronous prepare operation.
Remarks

To prepare the player, the player must be in the Idle state, and a source must be set.

Exceptions
Type Condition
InvalidOperationException

No source is set.
ObjectDisposedException

The player has already been disposed of.
InvalidOperationException

The player is not in the valid state.
See Also
API Level: 3
View Source

PrepareAsync(CancellationToken)

Prepares the cancelable media player for playback, asynchronously.

Declaration
public virtual Task PrepareAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
CancellationToken cancellationToken

The cancellation token to cancel preparing.
Returns
Type Description
Task

The task that represents the asynchronous prepare operation.
Remarks

To prepare the player, the player must be in the Idle state, and a source must be set. The state must be Preparing to cancel preparing. When preparing is cancelled, a state will be changed to Idle from Preparing.

Exceptions
Type Condition
ObjectDisposedException

The player has already been disposed.
InvalidOperationException

Operation failed; internal error. -or-
The player is not in the valid state.
See Also
API Level: 6
View Source

SetPlaybackRate(Single)

Sets the playback rate.

Declaration
public void SetPlaybackRate(float rate)
Parameters
Type Name Description
Single rate

The value for the playback rate. Valid range is -5.0 to 5.0, inclusive.
Remarks

The player must be in the Ready, Playing, or Paused state.

The sound will be muted, when the playback rate is under 0.0 or over 2.0.

Exceptions
Type Condition
ObjectDisposedException

The player has already been disposed of.
InvalidOperationException

The player is not in the valid state.
-or-
Streaming playback.
ArgumentOutOfRangeException

rate is less than -5.0.
-or-
rate is greater than 5.0.
-or-
rate is zero.
NotAvailableException

If audio offload is enabled by calling IsEnabled. (Since tizen 6.0)
See Also
API Level: 3
View Source

SetPlayPositionAsync(Int32, Boolean)

Sets the seek position for playback, asynchronously.

Declaration
public Task SetPlayPositionAsync(int position, bool accurate)
Parameters
Type Name Description
Int32 position

The value indicating a desired position in milliseconds.
Boolean accurate

The value indicating whether the operation performs with accuracy.
Returns
Type Description
Task

A task that represents the asynchronous operation.
Remarks

The player must be in the Ready, Playing, or Paused state.

If the accurate is true, the play position will be adjusted as the specified position value, but this might be considerably slow. If false, the play position will be a nearest keyframe position.

Exceptions
Type Condition
ObjectDisposedException

The player has already been disposed of.
InvalidOperationException

The player is not in the valid state.
-or-
In case of non-seekable content, the player will return error and keep playing without changing the play position.
ArgumentOutOfRangeException

The specified position is not valid.
See Also
API Level: 3
View Source

SetPlayPositionNanosecondsAsync(Int64, Boolean)

Sets the seek position in nanoseconds for playback, asynchronously.

Declaration
public Task SetPlayPositionNanosecondsAsync(long position, bool accurate)
Parameters
Type Name Description
Int64 position

The value indicating a desired position in nanoseconds.
Boolean accurate

The value indicating whether the operation performs with accuracy.
Returns
Type Description
Task

A task that represents the asynchronous operation.
Remarks

The player must be in the Ready, Playing, or Paused state.

If the accurate is true, the play position will be adjusted as the specified position value, but this might be considerably slow. If false, the play position will be a nearest keyframe position.

Exceptions
Type Condition
ObjectDisposedException

The player has already been disposed of.
InvalidOperationException

The player is not in the valid state.
-or-
In case of non-seekable content, the player will return error and keep playing without changing the play position.
ArgumentOutOfRangeException

The specified position is not valid.
See Also
API Level: 5
View Source

SetSource(MediaSource)

Sets a media source for the player.

Declaration
public void SetSource(MediaSource source)
Parameters
Type Name Description
MediaSource source

A MediaSource that specifies the source for playback.
Remarks

The player must be in the Idle state.

Exceptions
Type Condition
ObjectDisposedException

The player has already been disposed of.
InvalidOperationException

The player is not in the valid state.
-or-
It is not able to assign the source to the player.
UnauthorizedAccessException

Thrown when the permission is denied.
See Also
API Level: 3
View Source

SetSubtitle(String)

Sets the subtitle path for playback.

Declaration
public void SetSubtitle(string path)
Parameters
Type Name Description
String path

The absolute path of the subtitle file, it can be NULL in the Idle state.
Remarks

Only MicroDVD/SubViewer(.sub), SAMI(.smi), and SubRip(*.srt) subtitle formats are supported.

The mediastorage privilege(http://tizen.org/privilege/mediastorage) must be added if any files are used to play located in the internal storage. The externalstorage privilege(http://tizen.org/privilege/externalstorage) must be added if any files are used to play located in the external storage.

Exceptions
Type Condition
ObjectDisposedException

The player has already been disposed of.
ArgumentException

path is an empty string.
FileNotFoundException

The specified path does not exist.
ArgumentNullException

path is null.
API Level: 3
View Source

SetSubtitleOffset(Int32)

Sets the offset for the subtitle.

Declaration
public void SetSubtitleOffset(int offset)
Parameters
Type Name Description
Int32 offset

The value indicating a desired offset in milliseconds.
Remarks

The player must be in the Playing or Paused state.

Exceptions
Type Condition
ObjectDisposedException

The player has already been disposed of.
InvalidOperationException

The player is not in the valid state.
-or-
No subtitle is set.
See Also
API Level: 3
View Source

SetVideoRoi(ScaleRectangle)

Set the relative ROI (Region Of Interest) area as a decimal fraction based on the video source. It can be regarded as zooming operation because the specified video area will be rendered to fit to the display.

Declaration
public void SetVideoRoi(ScaleRectangle scaleRectangle)
Parameters
Type Name Description
ScaleRectangle scaleRectangle

The containing the ROI area information.
Remarks

This function requires the ratio of the each coordinate and size to the video resolution size to guarantee of showing the same area for the dynamic resolution video content. This function have to be called after setting Display

Exceptions
Type Condition
ObjectDisposedException

The player has already been disposed of.
InvalidOperationException

Operation failed; internal error. -or-
The Tizen.Multimedia.PlayerDisplayType is not set to Tizen.Multimedia.PlayerDisplayType.Overlay.
ArgumentOutOfRangeException

scaleRectangle.ScaleX.ScaleX is less than 0.0 or greater than 1.0.
-or-
scaleRectangle.ScaleY.ScaleY is less than 0.0 or greater than 1.0.
-or-
scaleRectangle.ScaleWidth.ScaleWidth is less than or equal to 0.0 or greater than 1.0.
-or-
scaleRectangle.ScaleHeight.ScaleHeight is less than or equal to 0.0 or greater than 1.0.
See Also
API Level: 5
View Source

Start()

Starts or resumes playback.

Declaration
public virtual void Start()
Remarks

Sound can be mixed with other sounds if you don't control the stream focus using ApplyAudioStreamPolicy(AudioStreamPolicy).

Before Tizen 5.0, The player must be in the Ready or Paused state. It has no effect if the player is already in the Playing state.

Since Tizen 5.0, The player must be in the Ready, Playing, or Paused state.
In case of HTTP streaming playback, the player could be internally paused for buffering. If the application calls this function during the buffering, the playback will be resumed by force and the buffering message posting by BufferingProgressChanged will be stopped.
In other cases, the player will keep playing without returning error.

Exceptions
Type Condition
ObjectDisposedException

The player has already been disposed of.
InvalidOperationException

The player is not in the valid state.
See Also
API Level: 3
View Source

Stop()

Stops playing the media content.

Declaration
public virtual void Stop()
Remarks

The player must be in the Playing or Paused state. It has no effect if the player is already in the Ready state.

Exceptions
Type Condition
ObjectDisposedException

The player has already been disposed of.
InvalidOperationException

The player is not in the valid state.
See Also
API Level: 3
View Source

Unprepare()

Unprepares the player.

Declaration
public virtual void Unprepare()
Remarks

The most recently used source is reset and is no longer associated with the player. Playback is no longer possible. If you want to use the player again, you have to set a source and call PrepareAsync() or PrepareAsync(CancellationToken) again.

The player must be in the Ready, Playing, or Paused state. It has no effect if the player is already in the Idle state.

Exceptions
Type Condition
ObjectDisposedException

The player has already been disposed of.
InvalidOperationException

The player is not in the valid state.
API Level: 3

Events

View Source

AudioDataDecoded

Occurs when a audio frame is decoded.

Declaration
public event EventHandler<AudioDataDecodedEventArgs> AudioDataDecoded
Event Type
Type Description
EventHandler<AudioDataDecodedEventArgs>
Remarks

The event handler will be executed on an internal thread.

The Packet in event args should be disposed after use.

See Also
API Level: 6
View Source

BufferingProgressChanged

Occurs when there is a change in the buffering status of streaming.

Declaration
public event EventHandler<BufferingProgressChangedEventArgs> BufferingProgressChanged
Event Type
Type Description
EventHandler<BufferingProgressChangedEventArgs>
API Level: 3
View Source

ErrorOccurred

Occurs when any error occurs.

Declaration
public event EventHandler<PlayerErrorOccurredEventArgs> ErrorOccurred
Event Type
Type Description
EventHandler<PlayerErrorOccurredEventArgs>
Remarks

The event handler will be executed on an internal thread.

API Level: 3
View Source

PlaybackCompleted

Occurs when the playback of a media is finished.

Declaration
public event EventHandler<EventArgs> PlaybackCompleted
Event Type
Type Description
EventHandler<EventArgs>
API Level: 3
View Source

PlaybackInterrupted

Occurs when the playback of a media is interrupted.

Declaration
public event EventHandler<PlaybackInterruptedEventArgs> PlaybackInterrupted
Event Type
Type Description
EventHandler<PlaybackInterruptedEventArgs>
Remarks

If the reason is ResourceConflict, the player state will be one of Idle, Ready, or Paused.

See Also
API Level: 3
View Source

SubtitleUpdated

Occurs when the subtitle is updated.

Declaration
public event EventHandler<SubtitleUpdatedEventArgs> SubtitleUpdated
Event Type
Type Description
EventHandler<SubtitleUpdatedEventArgs>
Remarks

The event handler will be executed on an internal thread.

API Level: 3
View Source

VideoFrameDecoded

Occurs when a video frame is decoded.

Declaration
public event EventHandler<VideoFrameDecodedEventArgs> VideoFrameDecoded
Event Type
Type Description
EventHandler<VideoFrameDecodedEventArgs>
Remarks

The event handler will be executed on an internal thread.

The Packet in event args should be disposed after use.

Exceptions
Type Condition
NotSupportedException

The required feature is not supported.
See Also
API Level: 3
Feature: http://tizen.org/feature/multimedia.raw_video
View Source

VideoStreamChanged

Occurs when the video stream is changed.

Declaration
public event EventHandler<VideoStreamChangedEventArgs> VideoStreamChanged
Event Type
Type Description
EventHandler<VideoStreamChangedEventArgs>
Remarks

The event handler will be executed on an internal thread.

API Level: 3

Implements