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

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

Start()

Stop()

Methods

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

MediaControllerManager

MediaController

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

MediaControllerManager

MediaController

RequestAsync(Command, string)

Requests commands to the client.

Declaration

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.

Remarks

The client can request the command to execute Command,
and then, the server receive 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.

See Also

MediaControllerManager

MediaController

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

MediaControllerManager

MediaController

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

MediaControllerManager

MediaController

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

MediaControllerManager

MediaController

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

MediaControllerManager

MediaController

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

MediaControllerManager

MediaController

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

MediaControllerManager

MediaController

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

MediaControllerManager

MediaController

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

MediaControllerManager

MediaController

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

MediaControllerManager

MediaController

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

MediaControllerManager

MediaController

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

MediaControllerManager

MediaController

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

MediaControllerManager

MediaController

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

MediaControllerManager

MediaController

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

MediaControllerManager

MediaController

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

MediaControllerManager

MediaController

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

MediaControllerManager

MediaController

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

MediaControllerManager

MediaController

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

MediaControllerManager

MediaController

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

MediaControllerManager

MediaController

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

MediaControllerManager

MediaController

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

MediaControllerManager

MediaController

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

MediaControllerManager

MediaController

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

MediaControllerManager

MediaController

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

MediaControllerManager

MediaController

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

MediaControllerManager

MediaController

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

ServerStarted

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

ServerStopped

Events

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

MediaControllerManager

MediaController

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

MediaControllerManager

MediaController

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

MediaControllerManager

MediaController

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

MediaControllerManager

MediaController

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

MediaControllerManager

MediaController

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

MediaControllerManager

MediaController

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

MediaControllerManager

MediaController

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

MediaControllerManager

MediaController

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

MediaControllerManager

MediaController

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

MediaControllerManager

MediaController

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

MediaControllerManager

MediaController

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

MediaControllerManager

MediaController

See Also

MediaControllerManager

MediaController