Class MediaController

Definition

Namespace:

Tizen.Multimedia.Remoting

Assembly:

Tizen.Multimedia.Remoting.dll

Provides a means to send commands to and handle events from media control server.

public class MediaController

Inheritance

object

MediaController

Properties

IsStopped

Gets a value indicating whether the sever has been stopped.

Declaration

public bool IsStopped { get; }

Property Value

Type	Description
bool	true if the server has been stopped; otherwise, false.

ServerAppId

Gets the application id of the server.

Declaration

public string ServerAppId { get; }

Property Value

Type	Description
string	The server application id.

Methods

GetAgeRatingOfCurrentPlayingMedia()

Gets the age rating of current playing media.

Declaration

public int GetAgeRatingOfCurrentPlayingMedia()

Returns

Type	Description
int	The Age rating of current playing media. The range is 0 to 19, inclusive.

Exceptions

Type	Condition
System.InvalidOperationException	The server has already been stopped. -or- An internal error occurs.
System.ObjectDisposedException	The MediaControllerManager has already been disposed of.

GetContentTypeOfCurrentPlayingMedia()

Gets the content type of current playing media.

Declaration

public MediaControlContentType GetContentTypeOfCurrentPlayingMedia()

Returns

Type	Description
MediaControlContentType	The MediaControlContentType.

Exceptions

Type	Condition
System.InvalidOperationException	The server has already been stopped. -or- An internal error occurs.
System.ObjectDisposedException	The MediaControllerManager has already been disposed of.

GetIconPath()

Gets the icon path.

Declaration

public string GetIconPath()

Returns

Type	Description
string	The icon path.

Exceptions

Type	Condition
System.InvalidOperationException	The server has already been stopped. -or- An internal error occurs.
System.ObjectDisposedException	The MediaControllerManager has already been disposed of.

GetIndexOfCurrentPlayingMedia()

Returns the index of current playing media.

Declaration

public string GetIndexOfCurrentPlayingMedia()

Returns

Type	Description
string	The index of current playing media.

Exceptions

Type	Condition
System.InvalidOperationException	The server has already been stopped. -or- An internal error occurs.
System.ObjectDisposedException	The MediaControllerManager has already been disposed of.

GetMetadata()

Returns the metadata set by the server.

Declaration

public MediaControlMetadata GetMetadata()

Returns

Type	Description
MediaControlMetadata	The metadata.

Exceptions

Type	Condition
System.InvalidOperationException	The server has already been stopped. -or- An internal error occurs.
System.ObjectDisposedException	The MediaControllerManager has already been disposed of.

See Also

SetMetadata(MediaControlMetadata)

GetPlaybackCapabilities()

Gets the value whether MediaControlPlaybackCommand is supported or not.

Declaration

public Dictionary<MediaControlPlaybackCommand, MediaControlCapabilitySupport> GetPlaybackCapabilities()

Returns

Type	Description
System.Collections.Generic.Dictionary<TKey, TValue><MediaControlPlaybackCommand, MediaControlCapabilitySupport>	the set of MediaControlPlaybackCommand and MediaControlCapabilitySupport.

Exceptions

Type	Condition
System.InvalidOperationException	The server has already been stopped. -or- An internal error occurs.
System.ObjectDisposedException	The MediaControllerManager has already been disposed of.

GetPlaybackCapability(MediaControlPlaybackCommand)

Gets the value whether action is supported or not.

Declaration

public MediaControlCapabilitySupport GetPlaybackCapability(MediaControlPlaybackCommand action)

Parameters

Type	Name	Description
MediaControlPlaybackCommand	action	A playback command.

Returns

Type	Description
MediaControlCapabilitySupport	A MediaControlCapabilitySupport.

Exceptions

Type	Condition
System.ArgumentException	action is not valid.
System.InvalidOperationException	The server has already been stopped. -or- An internal error occurs.
System.ObjectDisposedException	The MediaControllerManager has already been disposed of.

GetPlaybackPosition()

Returns the playback position set by the server.

Declaration

public long GetPlaybackPosition()

Returns

Type	Description
long	The playback position in milliseconds.

Exceptions

Type	Condition
System.InvalidOperationException	The server has already been stopped. -or- An internal error occurs.
System.ObjectDisposedException	The MediaControllerManager has already been disposed of.

See Also

SetPlaybackState(MediaControlPlaybackState, long)

GetPlaybackState()

Returns the playback state set by the server.

Declaration

public MediaControlPlaybackState GetPlaybackState()

Returns

Type	Description
MediaControlPlaybackState	The playback state.

Exceptions

Type	Condition
System.InvalidOperationException	The server has already been stopped. -or- An internal error occurs.
System.ObjectDisposedException	The MediaControllerManager has already been disposed of.

See Also

SetPlaybackState(MediaControlPlaybackState, long)

GetPlaylistOfCurrentPlayingMedia()

Returns the playlist name of current playing media.

Declaration

public MediaControlPlaylist GetPlaylistOfCurrentPlayingMedia()

Returns

Type	Description
MediaControlPlaylist	The playlist name.

Exceptions

Type	Condition
System.InvalidOperationException	The server has already been stopped. -or- An internal error occurs.
System.ObjectDisposedException	The MediaControllerManager has already been disposed of.

GetPlaylists()

Returns the all playlists.

Declaration

public IEnumerable<MediaControlPlaylist> GetPlaylists()

Returns

Type	Description
System.Collections.Generic.IEnumerable<T><MediaControlPlaylist>	The set of MediaControlPlaylist.

Exceptions

Type	Condition
System.InvalidOperationException	The server has already been stopped. -or- An internal error occurs.
System.ObjectDisposedException	The MediaControllerManager has already been disposed of.

GetRepeatMode()

Returns the repeat mode.

Declaration

public MediaControlRepeatMode GetRepeatMode()

Returns

Type	Description
MediaControlRepeatMode	A MediaControlRepeatMode set by the server.

Exceptions

Type	Condition
System.InvalidOperationException	The server has already been stopped. -or- An internal error occurs.
System.ObjectDisposedException	The MediaControllerManager has already been disposed of.

See Also

SetRepeatMode(MediaControlRepeatMode)

GetRepeatModeCapability()

Gets the value whether the repeat mode is supported or not.

Declaration

public MediaControlCapabilitySupport GetRepeatModeCapability()

Returns

Type	Description
MediaControlCapabilitySupport	A MediaControlCapabilitySupport.

Exceptions

Type	Condition
System.InvalidOperationException	The server has already been stopped. -or- An internal error occurs.
System.ObjectDisposedException	The MediaControllerManager has already been disposed of.

GetShuffleModeCapability()

Gets the value whether the shuffle mode is supported or not.

Declaration

public MediaControlCapabilitySupport GetShuffleModeCapability()

Returns

Type	Description
MediaControlCapabilitySupport	A MediaControlCapabilitySupport.

Exceptions

Type	Condition
System.InvalidOperationException	The server has already been stopped. -or- An internal error occurs.
System.ObjectDisposedException	The MediaControllerManager has already been disposed of.

IsShuffleModeEnabled()

Returns whether the shuffle mode is enabled.

Declaration

public bool IsShuffleModeEnabled()

Returns

Type	Description
bool	A value indicating whether the shuffle mode is enabled.

Exceptions

Type	Condition
System.InvalidOperationException	The server has already been stopped. -or- An internal error occurs.
System.ObjectDisposedException	The MediaControllerManager has already been disposed of.

See Also

SetShuffleModeEnabled(bool)

RequestAsync(Command)

Requests command to the server.

Declaration

public Task<Bundle> RequestAsync(Command command)

Parameters

Type	Name	Description
Command	command	A Command class.

Returns

Type	Description
System.Threading.Tasks.Task<TResult><Bundle>	Bundle represents the extra data from server and it can be null.

Remarks

The client can request the server to execute PlaybackCommand or ShuffleModeCommand or RepeatModeCommand or CustomCommand,
and then, the client receive the result of each request(command).

Exceptions

Type	Condition
System.ArgumentNullException	command is null.
System.InvalidOperationException	The server has already been stopped. -or- An internal error occurs.
System.ObjectDisposedException	The MediaControllerManager has already been disposed of.

Response(Command, int, Bundle)

Sends the result of each command.

Declaration

public void Response(Command command, int result, Bundle bundle)

Parameters

Type	Name	Description
Command	command	The command that return to client.
int	result	The result of command.
Bundle	bundle	The extra data.

Exceptions

Type	Condition
System.ArgumentNullException	command is null.
System.InvalidOperationException	The server is not running . -or- An internal error occurs.

Response(Command, int)

Sends the result of each command.

Declaration

public void Response(Command command, int result)

Parameters

Type	Name	Description
Command	command	The command that return to client.
int	result	The result of command.

Exceptions

Type	Condition
System.ArgumentNullException	command is null.
System.InvalidOperationException	The server is not running . -or- An internal error occurs.

SendPlaybackCommand(MediaControlPlaybackCommand)

Sends playback command to the server.

Declaration

[Obsolete("Please do not use! This will be deprecated. Please use Request instead.")]
public void SendPlaybackCommand(MediaControlPlaybackCommand command)

Parameters

Type	Name	Description
MediaControlPlaybackCommand	command	A playback command.

Exceptions

Type	Condition
System.InvalidOperationException	The server has already been stopped. -or- An internal error occurs.
System.ArgumentException	command is not valid.
System.ObjectDisposedException	The MediaControllerManager has already been disposed of.

See Also

PlaybackCommandReceived

Events

CustomCommandReceived

Occurs when a server sends custom event.

Declaration

public event EventHandler<CustomCommandReceivedEventArgs> CustomCommandReceived

Event Type

Type	Description
System.EventHandler<TEventArgs><CustomCommandReceivedEventArgs>

MetadataUpdated

Occurs when the metadata is updated.

Declaration

public event EventHandler<MetadataUpdatedEventArgs> MetadataUpdated

Event Type

Type	Description
System.EventHandler<TEventArgs><MetadataUpdatedEventArgs>

PlaybackCapabilityUpdated

Occurs when the playback capabilities are updated.

Declaration

public event EventHandler<PlaybackCapabilityUpdatedEventArgs> PlaybackCapabilityUpdated

Event Type

Type	Description
System.EventHandler<TEventArgs><PlaybackCapabilityUpdatedEventArgs>

PlaybackStateUpdated

Occurs when the playback state is updated.

Declaration

public event EventHandler<PlaybackStateUpdatedEventArgs> PlaybackStateUpdated

Event Type

Type	Description
System.EventHandler<TEventArgs><PlaybackStateUpdatedEventArgs>

PlaylistUpdated

Occurs when the playlist is updated.

Declaration

public event EventHandler<PlaylistUpdatedEventArgs> PlaylistUpdated

Event Type

Type	Description
System.EventHandler<TEventArgs><PlaylistUpdatedEventArgs>

RepeatModeCapabilityUpdated

Occurs when the repeat mode capabilities are updated.

Declaration

public event EventHandler<RepeatModeCapabilityUpdatedEventArgs> RepeatModeCapabilityUpdated

Event Type

Type	Description
System.EventHandler<TEventArgs><RepeatModeCapabilityUpdatedEventArgs>

RepeatModeUpdated

Occurs when the repeat mode is updated.

Declaration

public event EventHandler<RepeatModeUpdatedEventArgs> RepeatModeUpdated

Event Type

Type	Description
System.EventHandler<TEventArgs><RepeatModeUpdatedEventArgs>

ServerStopped

Occurs when the server is stopped.

Declaration

public event EventHandler ServerStopped

Event Type

Type	Description
System.EventHandler

ShuffleModeCapabilityUpdated

Occurs when the shuffle mode capabilities are updated.

Declaration

public event EventHandler<ShuffleModeCapabilityUpdatedEventArgs> ShuffleModeCapabilityUpdated

Event Type

Type	Description
System.EventHandler<TEventArgs><ShuffleModeCapabilityUpdatedEventArgs>

ShuffleModeUpdated

Occurs when the shuffle mode is updated.

Declaration

public event EventHandler<ShuffleModeUpdatedEventArgs> ShuffleModeUpdated

Event Type

Type	Description
System.EventHandler<TEventArgs><ShuffleModeUpdatedEventArgs>