Class MediaControlServer

Definition

Namespace:
Tizen.Multimedia.Remoting
Assembly:
Tizen.Multimedia.Remoting.dll

Provides a means to set playback information and metadata and receive commands from clients.

public static class MediaControlServer
Inheritance
object
MediaControlServer

Properties

View Source

IsRunning

Gets a value indicating whether the server is running.

Declaration
public static bool IsRunning { get; }
Property Value
Type Description
bool

true if the server has started; otherwise, false.
See Also

Methods

View Source

GetActivatedClients()

Gets the active clients.

Declaration
public static IEnumerable<string> GetActivatedClients()
Returns
Type Description
System.Collections.Generic.IEnumerable<T><string>

the activated client ids.
Exceptions
Type Condition
System.InvalidOperationException

The server is not running .
-or-
An internal error occurs.
See Also
View Source

RemovePlaylist(MediaControlPlaylist)

Delete playlist.

Declaration
public static void RemovePlaylist(MediaControlPlaylist playlist)
Parameters
Type Name Description
MediaControlPlaylist playlist

The name of playlist.
Remarks

Currently, only server can remove the playlist.

Exceptions
Type Condition
System.ArgumentNullException

playlist is null.
System.InvalidOperationException

The server is not running .
-or-
An internal error occurs.
See Also
View Source

RequestAsync(Command, string)

Requests commands to the client.

Declaration
[Obsolete("Deprecated since API8; Will be removed in API10. Please use RequestCommandAsync(Command command) instead.")]
public static Task<Bundle> RequestAsync(Command command, string clientId)
Parameters
Type Name Description
Command command

A Command class.
string clientId

The client Id to send command.
Returns
Type Description
System.Threading.Tasks.Task<TResult><Bundle>

Bundle represents the extra data from client and it can be null.
Exceptions
Type Condition
System.ArgumentNullException

command or clientId is null.
System.InvalidOperationException

The server has already been stopped.
-or-
An internal error occurs.
See Also
View Source

RequestCommandAsync(Command, string)

Requests a command to the client and server receives the result of each request(command).

Declaration
public static Task<(Bundle bundle, int result)> RequestCommandAsync(Command command, string clientId)
Parameters
Type Name Description
Command command

A Command class.
string clientId

The client Id to send command.
Returns
Type Description
System.Threading.Tasks.Task<TResult><(Bundle bundle, int result)>

The type of return value is Tuple.
First item of Tuple represents the Bundle and it represents the extra data from client. It can be null.
Second item of Tuple represents the result of each request(command).
Exceptions
Type Condition
System.ArgumentNullException

command or clientId is null.
System.InvalidOperationException

The server has already been stopped.
-or-
An internal error occurs.
System.NotImplementedException

The command which is not supported is used.
See Also
View Source

Response(Command, int, Bundle)

Sends the result of each command.

Declaration
public static 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.
See Also
View Source

Response(Command, int)

Sends the result of each command.

Declaration
public static 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.
See Also
View Source

Response(Command, MediaControlResult, Bundle)

Sends the result of each command.

Declaration
public static void Response(Command command, MediaControlResult result, Bundle bundle)
Parameters
Type Name Description
Command command

The command that return to client.
MediaControlResult result

The MediaControlResult 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.
See Also
View Source

Response(Command, MediaControlResult)

Sends the result of each command.

Declaration
public static void Response(Command command, MediaControlResult result)
Parameters
Type Name Description
Command command

The command that return to client.
MediaControlResult result

The MediaControlResult of command.
Exceptions
Type Condition
System.ArgumentNullException

command is null.
System.InvalidOperationException

The server is not running .
-or-
An internal error occurs.
See Also
View Source

SetAgeRating(int)

Sets the age rating of latest played media.

Declaration
public static void SetAgeRating(int ageRating)
Parameters
Type Name Description
int ageRating

The Age rating of latest played media. The valid range is 0 to 19, inclusive. Especially, 0 means that media is suitable for all ages.
Exceptions
Type Condition
System.ArgumentOutOfRangeException

The specified ageRating is not valid.
System.InvalidOperationException

The server is not running .
-or-
An internal error occurs.
See Also
View Source

SetCustomCommandCapability(MediaControlCapabilitySupport)

Sets the MediaControlCapabilitySupport indicating custom command is supported or not.

Declaration
public static void SetCustomCommandCapability(MediaControlCapabilitySupport support)
Parameters
Type Name Description
MediaControlCapabilitySupport support

A value indicating whether the custom command is supported or not.
Exceptions
Type Condition
System.InvalidOperationException

The server is not running .
-or-
An internal error occurs.
System.ArgumentException

support is invalid.
See Also
View Source

SetDisplayMode(MediaControlDisplayMode)

Sets the display mode.

Declaration
public static void SetDisplayMode(MediaControlDisplayMode mode)
Parameters
Type Name Description
MediaControlDisplayMode mode

A value indicating the MediaControlDisplayMode.
Exceptions
Type Condition
System.InvalidOperationException

The server is not running .
-or-
An internal error occurs.
See Also
View Source

SetDisplayModeCapabilities(IDictionary<MediaControlDisplayMode, MediaControlCapabilitySupport>)

Sets the supported list of MediaControlDisplayMode.

Declaration
public static void SetDisplayModeCapabilities(IDictionary<MediaControlDisplayMode, MediaControlCapabilitySupport> capabilities)
Parameters
Type Name Description
System.Collections.Generic.IDictionary<TKey, TValue><MediaControlDisplayMode, MediaControlCapabilitySupport> capabilities

The supported list of MediaControlDisplayMode.
Remarks

NotDecided is not allowed in display mode capability. The default value of each MediaControlDisplayMode is not supported.

Exceptions
Type Condition
System.InvalidOperationException

The server is not running .
-or-
An internal error occurs.
System.ArgumentException

capabilities is invalid.
See Also
View Source

SetDisplayModeCapability(MediaControlDisplayMode, MediaControlCapabilitySupport)

Sets the mode is supported or not.

Declaration
public static void SetDisplayModeCapability(MediaControlDisplayMode mode, MediaControlCapabilitySupport support)
Parameters
Type Name Description
MediaControlDisplayMode mode

The MediaControlDisplayMode.
MediaControlCapabilitySupport support

A value indicating whether the mode is supported or not.
Remarks

NotDecided is not allowed in display mode capability.
The default value of each MediaControlDisplayMode is not supported.

Exceptions
Type Condition
System.InvalidOperationException

The server is not running .
-or-
An internal error occurs.
System.ArgumentException

mode or support is invalid.
See Also
View Source

SetDisplayRotation(Rotation)

Sets the display rotation.

Declaration
public static void SetDisplayRotation(Rotation rotation)
Parameters
Type Name Description
Rotation rotation

A value indicating the Rotation.
Exceptions
Type Condition
System.InvalidOperationException

The server is not running .
-or-
An internal error occurs.
See Also
View Source

SetDisplayRotationCapabilities(IDictionary<Rotation, MediaControlCapabilitySupport>)

Sets the supported list of Rotation.

Declaration
public static void SetDisplayRotationCapabilities(IDictionary<Rotation, MediaControlCapabilitySupport> capabilities)
Parameters
Type Name Description
System.Collections.Generic.IDictionary<TKey, TValue><Rotation, MediaControlCapabilitySupport> capabilities

The supported list of Rotation.
Remarks

NotDecided is not allowed in display rotation capability.
The default value of each Rotation is not supported.

Exceptions
Type Condition
System.InvalidOperationException

The server is not running .
-or-
An internal error occurs.
System.ArgumentException

capabilities is invalid.
See Also
View Source

SetDisplayRotationCapability(Rotation, MediaControlCapabilitySupport)

Sets the rotation is supported or not.

Declaration
public static void SetDisplayRotationCapability(Rotation rotation, MediaControlCapabilitySupport support)
Parameters
Type Name Description
Rotation rotation

The Rotation.
MediaControlCapabilitySupport support

A value indicating whether the rotation is supported or not..
Remarks

NotDecided is not allowed in display rotation capability.
The default value of each Rotation is not supported.

Exceptions
Type Condition
System.InvalidOperationException

The server is not running .
-or-
An internal error occurs.
System.ArgumentException

rotation or support is invalid.
See Also
View Source

SetIconPath(string)

Sets the path of icon.

Declaration
public static void SetIconPath(string path)
Parameters
Type Name Description
string path

The path of icon.
Exceptions
Type Condition
System.InvalidOperationException

The server is not running .
-or-
An internal error occurs.
System.ArgumentNullException

path is invalid.
See Also
View Source

SetIndexOfCurrentPlayingMedia(string)

Sets the index of current playing media.

Declaration
[Obsolete("Please do not use! This will be deprecated. Please use SetInfoOfCurrentPlayingMedia instead.")]
public static void SetIndexOfCurrentPlayingMedia(string index)
Parameters
Type Name Description
string index

The index of current playing media.
Exceptions
Type Condition
System.ArgumentNullException

index is null.
System.InvalidOperationException

The server is not running .
-or-
An internal error occurs.
See Also
View Source

SetInfoOfCurrentPlayingMedia(string, string)

Sets the playlist name and index of current playing media.

Declaration
public static void SetInfoOfCurrentPlayingMedia(string playlistName, string index)
Parameters
Type Name Description
string playlistName

The playlist name of current playing media.
string index

The index of current playing media.
Exceptions
Type Condition
System.ArgumentNullException

playlistName or index is null.
System.InvalidOperationException

The server is not running .
-or-
An internal error occurs.
See Also
View Source

SetMetadata(MediaControlMetadata)

Updates metadata information.

Declaration
public static void SetMetadata(MediaControlMetadata metadata)
Parameters
Type Name Description
MediaControlMetadata metadata

The metadata to update.
Exceptions
Type Condition
System.ArgumentNullException

metadata is null.
System.InvalidOperationException

The server is not running .
-or-
An internal error occurs.
See Also
View Source

SetMode360(bool)

Sets the 360 mode.

Declaration
public static void SetMode360(bool isEnabled)
Parameters
Type Name Description
bool isEnabled

A value indicating whether the 360 mode is enabled.
Exceptions
Type Condition
System.InvalidOperationException

The server is not running .
-or-
An internal error occurs.
See Also
View Source

SetMode360Capability(MediaControlCapabilitySupport)

Sets the MediaControlCapabilitySupport indicating whether 360 mode is supported or not.

Declaration
public static void SetMode360Capability(MediaControlCapabilitySupport support)
Parameters
Type Name Description
MediaControlCapabilitySupport support

A value indicating whether the 360 mode is supported or not.
Exceptions
Type Condition
System.InvalidOperationException

The server is not running .
-or-
An internal error occurs.
System.ArgumentException

support is invalid.
See Also
View Source

SetPlaybackCapabilities(Dictionary<MediaControlPlaybackCommand, MediaControlCapabilitySupport>)

Sets the capabilities by MediaControlPlaybackCommand.

Declaration
public static void SetPlaybackCapabilities(Dictionary<MediaControlPlaybackCommand, MediaControlCapabilitySupport> capabilities)
Parameters
Type Name Description
System.Collections.Generic.Dictionary<TKey, TValue><MediaControlPlaybackCommand, MediaControlCapabilitySupport> capabilities

The set of MediaControlPlaybackCommand and MediaControlCapabilitySupport.
Exceptions
Type Condition
System.InvalidOperationException

The server is not running .
-or-
An internal error occurs.
System.ArgumentException

capabilities is invalid.
See Also
View Source

SetPlaybackCapability(MediaControlPlaybackCommand, MediaControlCapabilitySupport)

Sets the capabilities by MediaControlPlaybackCommand.

Declaration
public static void SetPlaybackCapability(MediaControlPlaybackCommand action, MediaControlCapabilitySupport support)
Parameters
Type Name Description
MediaControlPlaybackCommand action

A playback command.
MediaControlCapabilitySupport support

A value indicating whether the action is supported or not.
Exceptions
Type Condition
System.InvalidOperationException

The server is not running .
-or-
An internal error occurs.
System.ArgumentException

action or support is invalid.
See Also
View Source

SetPlaybackContentType(MediaControlContentType)

Sets the content type of latest played media.

Declaration
public static void SetPlaybackContentType(MediaControlContentType type)
Parameters
Type Name Description
MediaControlContentType type

A value indicating the content type of the latest played media.
Exceptions
Type Condition
System.InvalidOperationException

The server is not running .
-or-
An internal error occurs.
System.ArgumentException

type is invalid.
See Also
View Source

SetPlaybackPositionCapability(MediaControlCapabilitySupport)

Sets the MediaControlCapabilitySupport indicating playback position is supported or not.

Declaration
public static void SetPlaybackPositionCapability(MediaControlCapabilitySupport support)
Parameters
Type Name Description
MediaControlCapabilitySupport support

A value indicating whether the playback position is supported or not.
Exceptions
Type Condition
System.InvalidOperationException

The server is not running .
-or-
An internal error occurs.
System.ArgumentException

support is invalid.
See Also
View Source

SetPlaybackState(MediaControlPlaybackState, long)

Updates playback state and playback position.

Declaration
public static void SetPlaybackState(MediaControlPlaybackState state, long position)
Parameters
Type Name Description
MediaControlPlaybackState state

The playback state.
long position

The playback position in milliseconds.
Exceptions
Type Condition
System.ArgumentException

state is not valid.
System.ArgumentOutOfRangeException

position is less than zero.
System.InvalidOperationException

The server is not running .
-or-
An internal error occurs.
See Also
View Source

SetPlaylistCapability(MediaControlCapabilitySupport)

Sets the MediaControlCapabilitySupport indicating playlist is supported or not.

Declaration
public static void SetPlaylistCapability(MediaControlCapabilitySupport support)
Parameters
Type Name Description
MediaControlCapabilitySupport support

A value indicating whether the playlist is supported or not.
Exceptions
Type Condition
System.InvalidOperationException

The server is not running .
-or-
An internal error occurs.
System.ArgumentException

support is invalid.
See Also
View Source

SetRepeatMode(MediaControlRepeatMode)

Updates the repeat mode.

Declaration
public static void SetRepeatMode(MediaControlRepeatMode mode)
Parameters
Type Name Description
MediaControlRepeatMode mode

A value indicating the repeat mode.
Exceptions
Type Condition
System.InvalidOperationException

The server is not running .
-or-
An internal error occurs.
System.ArgumentException

mode is invalid.
See Also
View Source

SetRepeatModeCapability(MediaControlCapabilitySupport)

Sets the MediaControlCapabilitySupport indicating repeat mode is supported or not.

Declaration
public static void SetRepeatModeCapability(MediaControlCapabilitySupport support)
Parameters
Type Name Description
MediaControlCapabilitySupport support

A value indicating whether the MediaControlRepeatMode is supported or not.
Exceptions
Type Condition
System.InvalidOperationException

The server is not running .
-or-
An internal error occurs.
System.ArgumentException

support is invalid.
See Also
View Source

SetSearchCapability(MediaControlCapabilitySupport)

Sets the MediaControlCapabilitySupport indicating search is supported or not.

Declaration
public static void SetSearchCapability(MediaControlCapabilitySupport support)
Parameters
Type Name Description
MediaControlCapabilitySupport support

A value indicating whether the search is supported or not.
Exceptions
Type Condition
System.InvalidOperationException

The server is not running .
-or-
An internal error occurs.
System.ArgumentException

support is invalid.
See Also
View Source

SetShuffleModeCapability(MediaControlCapabilitySupport)

Sets the MediaControlCapabilitySupport indicating shuffle mode is supported or not.

Declaration
public static void SetShuffleModeCapability(MediaControlCapabilitySupport support)
Parameters
Type Name Description
MediaControlCapabilitySupport support

A value indicating whether the shuffle mode is supported or not.
Exceptions
Type Condition
System.InvalidOperationException

The server is not running .
-or-
An internal error occurs.
System.ArgumentException

support is invalid.
See Also
View Source

SetShuffleModeEnabled(bool)

Updates the shuffle mode.

Declaration
public static void SetShuffleModeEnabled(bool enabled)
Parameters
Type Name Description
bool enabled

A value indicating whether the shuffle mode is enabled.
Exceptions
Type Condition
System.InvalidOperationException

The server is not running .
-or-
An internal error occurs.
See Also
View Source

SetSubtitleMode(bool)

Sets the subtitle mode.

Declaration
public static void SetSubtitleMode(bool isEnabled)
Parameters
Type Name Description
bool isEnabled

A value indicating whether the subtitle mode is enabled.
Exceptions
Type Condition
System.InvalidOperationException

The server is not running .
-or-
An internal error occurs.
See Also
View Source

SetSubtitleModeCapability(MediaControlCapabilitySupport)

Sets the MediaControlCapabilitySupport indicating whether subtitle mode is supported or not.

Declaration
public static void SetSubtitleModeCapability(MediaControlCapabilitySupport support)
Parameters
Type Name Description
MediaControlCapabilitySupport support

A value indicating whether the subtitle mode is supported or not.
Exceptions
Type Condition
System.InvalidOperationException

The server is not running .
-or-
An internal error occurs.
System.ArgumentException

support is invalid.
See Also
View Source

Start()

Starts the media control server.

Declaration
public static void Start()
Remarks

When the server starts, ServerStarted will be raised.

Exceptions
Type Condition
System.InvalidOperationException

An internal error occurs.
System.UnauthorizedAccessException

Caller does not have required privilege.
See Also
View Source

Stop()

Stops the media control server.

Declaration
public static void Stop()
Remarks

When the server stops, ServerStopped will be raised.

Exceptions
Type Condition
System.InvalidOperationException

The server is not running .
-or-
An internal error occurs.
See Also

Events

View Source

CustomCommandReceived

Occurs when a client sends custom command.

Declaration
public static event EventHandler<CustomCommandReceivedEventArgs> CustomCommandReceived
Event Type
Type Description
System.EventHandler<TEventArgs><CustomCommandReceivedEventArgs>
See Also
View Source

DisplayModeCommandReceived

Occurs when a client sends display mode command.

Declaration
public static event EventHandler<DisplayModeCommandReceivedEventArgs> DisplayModeCommandReceived
Event Type
Type Description
System.EventHandler<TEventArgs><DisplayModeCommandReceivedEventArgs>
See Also
View Source

DisplayRotationCommandReceived

Occurs when a client sends display rotation command.

Declaration
public static event EventHandler<DisplayRotationCommandReceivedEventArgs> DisplayRotationCommandReceived
Event Type
Type Description
System.EventHandler<TEventArgs><DisplayRotationCommandReceivedEventArgs>
See Also
View Source

Mode360CommandReceived

Occurs when a client sends mode 360 command.

Declaration
public static event EventHandler<Mode360CommandReceivedEventArgs> Mode360CommandReceived
Event Type
Type Description
System.EventHandler<TEventArgs><Mode360CommandReceivedEventArgs>
See Also
View Source

PlaybackActionCommandReceived

Occurs when a client sends playback command.

Declaration
public static event EventHandler<PlaybackActionCommandReceivedEventArgs> PlaybackActionCommandReceived
Event Type
Type Description
System.EventHandler<TEventArgs><PlaybackActionCommandReceivedEventArgs>
See Also
View Source

PlaybackCommandReceived

Occurs when a client sends playback command.

Declaration
[Obsolete("Please do not use! This will be deprecated. Please use PlaybackActionCommandReceived instead.")]
public static event EventHandler<PlaybackCommandReceivedEventArgs> PlaybackCommandReceived
Event Type
Type Description
System.EventHandler<TEventArgs><PlaybackCommandReceivedEventArgs>
See Also
View Source

PlaybackPositionCommandReceived

Occurs when a client sends playback position command.

Declaration
public static event EventHandler<PlaybackPositionCommandReceivedEventArgs> PlaybackPositionCommandReceived
Event Type
Type Description
System.EventHandler<TEventArgs><PlaybackPositionCommandReceivedEventArgs>
See Also
View Source

PlaylistCommandReceived

Occurs when a client sends playlist command.

Declaration
public static event EventHandler<PlaylistCommandReceivedEventArgs> PlaylistCommandReceived
Event Type
Type Description
System.EventHandler<TEventArgs><PlaylistCommandReceivedEventArgs>
See Also
View Source

RepeatModeCommandReceived

Occurs when a client sends repeat mode command.

Declaration
public static event EventHandler<RepeatModeCommandReceivedEventArgs> RepeatModeCommandReceived
Event Type
Type Description
System.EventHandler<TEventArgs><RepeatModeCommandReceivedEventArgs>
See Also
View Source

SearchCommandReceived

Occurs when a client sends search command.

Declaration
public static event EventHandler<SearchCommandReceivedEventArgs> SearchCommandReceived
Event Type
Type Description
System.EventHandler<TEventArgs><SearchCommandReceivedEventArgs>
See Also
View Source

ShuffleModeCommandReceived

Occurs when a client sends shuffle mode command.

Declaration
public static event EventHandler<ShuffleModeCommandReceivedEventArgs> ShuffleModeCommandReceived
Event Type
Type Description
System.EventHandler<TEventArgs><ShuffleModeCommandReceivedEventArgs>
See Also
View Source

SubtitleModeCommandReceived

Occurs when a client sends subtitle mode command.

Declaration
public static event EventHandler<SubtitleModeCommandReceivedEventArgs> SubtitleModeCommandReceived
Event Type
Type Description
System.EventHandler<TEventArgs><SubtitleModeCommandReceivedEventArgs>
See Also

See Also