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.


                C#
                
                    Copy
                    
                
            
public static class MediaControlServer

Inheritance: object

MediaControlServer

Properties

View Source

IsRunning

Gets a value indicating whether the server is running.

Declaration


                C#
                
                    Copy
                    
                
            
public static bool IsRunning { get; }

Property Value

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

Methods

View Source

GetActivatedClients()

Gets the active clients.

Declaration


                C#
                
                    Copy
                    
                
            
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.

RemovePlaylist(MediaControlPlaylist)

Delete playlist.

Declaration


                C#
                
                    Copy
                    
                
            
public static void RemovePlaylist(MediaControlPlaylist playlist)

Parameters

Type	Name	Description
MediaControlPlaylist	playlist	The name of playlist.

Exceptions

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

RequestAsync(Command, string)

Requests commands to the client.

Declaration


                C#
                
                    Copy
                    
                
            
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.

Response(Command, int, Bundle)

Sends the result of each command.

Declaration


                C#
                
                    Copy
                    
                
            
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.

Response(Command, int)

Sends the result of each command.

Declaration


                C#
                
                    Copy
                    
                
            
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.

SetAgeRating(int)

Sets the age rating of latest played media.

Declaration


                C#
                
                    Copy
                    
                
            
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.

SetIconPath(string)

Sets the path of icon.

Declaration


                C#
                
                    Copy
                    
                
            
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.

SetIndexOfCurrentPlayingMedia(string)

Sets the index of current playing media.

Declaration


                C#
                
                    Copy
                    
                
            
[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.

SetInfoOfCurrentPlayingMedia(string, string)

Sets the playlist name and index of current playing media.

Declaration


                C#
                
                    Copy
                    
                
            
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.

SetMetadata(MediaControlMetadata)

Updates metadata information.

Declaration


                C#
                
                    Copy
                    
                
            
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.

SetPlaybackCapabilities(Dictionary<MediaControlPlaybackCommand, MediaControlCapabilitySupport>)

Sets the capabilities by MediaControlPlaybackCommand.

Declaration


                C#
                
                    Copy
                    
                
            
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.

SetPlaybackCapability(MediaControlPlaybackCommand, MediaControlCapabilitySupport)

Sets the capabilities by MediaControlPlaybackCommand.

Declaration


                C#
                
                    Copy
                    
                
            
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.

SetPlaybackContentType(MediaControlContentType)

Sets the content type of latest played media.

Declaration


                C#
                
                    Copy
                    
                
            
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.

SetPlaybackState(MediaControlPlaybackState, long)

Updates playback state and playback position.

Declaration


                C#
                
                    Copy
                    
                
            
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.

SetRepeatMode(MediaControlRepeatMode)

Updates the repeat mode.

Declaration


                C#
                
                    Copy
                    
                
            
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.

SetRepeatModeCapability(MediaControlCapabilitySupport)

Sets the content type of latest played media.

Declaration


                C#
                
                    Copy
                    
                
            
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.

SetShuffleModeCapability(MediaControlCapabilitySupport)

Sets the MediaControlCapabilitySupport indicating shuffle mode is supported or not.

Declaration


                C#
                
                    Copy
                    
                
            
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.

SetShuffleModeEnabled(bool)

Updates the shuffle mode.

Declaration


                C#
                
                    Copy
                    
                
            
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.

Start()

Starts the media control server.

Declaration


                C#
                
                    Copy
                    
                
            
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.

Stop()

Stops the media control server.

Declaration


                C#
                
                    Copy
                    
                
            
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.

Events

View Source

CustomCommandReceived

Occurs when a client sends custom command.

Declaration


                C#
                
                    Copy
                    
                
            
public static event EventHandler<CustomCommandReceivedEventArgs> CustomCommandReceived

Event Type

Type	Description
System.EventHandler<TEventArgs><CustomCommandReceivedEventArgs>

PlaybackActionCommandReceived

Occurs when a client sends playback command.

Declaration


                C#
                
                    Copy
                    
                
            
public static event EventHandler<PlaybackActionCommandReceivedEventArgs> PlaybackActionCommandReceived

Event Type

Type	Description
System.EventHandler<TEventArgs><PlaybackActionCommandReceivedEventArgs>

PlaybackCommandReceived

Occurs when a client sends playback command.

Declaration


                C#
                
                    Copy
                    
                
            
[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>

PlaybackPositionCommandReceived

Occurs when a client sends playback position command.

Declaration


                C#
                
                    Copy
                    
                
            
public static event EventHandler<PlaybackPositionCommandReceivedEventArgs> PlaybackPositionCommandReceived

Event Type

Type	Description
System.EventHandler<TEventArgs><PlaybackPositionCommandReceivedEventArgs>

PlaylistCommandReceived

Occurs when a client sends playlist command.

Declaration


                C#
                
                    Copy
                    
                
            
public static event EventHandler<PlaylistCommandReceivedEventArgs> PlaylistCommandReceived

Event Type

Type	Description
System.EventHandler<TEventArgs><PlaylistCommandReceivedEventArgs>

RepeatModeCommandReceived

Occurs when a client sends repeat mode command.

Declaration


                C#
                
                    Copy
                    
                
            
public static event EventHandler<RepeatModeCommandReceivedEventArgs> RepeatModeCommandReceived

Event Type

Type	Description
System.EventHandler<TEventArgs><RepeatModeCommandReceivedEventArgs>

SearchCommandReceived

Occurs when a client sends search command.

Declaration


                C#
                
                    Copy
                    
                
            
public static event EventHandler<SearchCommandReceivedEventArgs> SearchCommandReceived

Event Type

Type	Description
System.EventHandler<TEventArgs><SearchCommandReceivedEventArgs>

ShuffleModeCommandReceived

Occurs when a client sends shuffle mode command.

Declaration


                C#
                
                    Copy
                    
                
            
public static event EventHandler<ShuffleModeCommandReceivedEventArgs> ShuffleModeCommandReceived

Event Type

Type	Description
System.EventHandler<TEventArgs><ShuffleModeCommandReceivedEventArgs>

Class MediaControlServer

Definition

Properties

IsRunning

Declaration

Property Value

See Also

Methods

GetActivatedClients()

Declaration

Returns

Exceptions

See Also

RemovePlaylist(MediaControlPlaylist)

Declaration

Parameters

Exceptions

See Also

RequestAsync(Command, string)

Declaration

Parameters

Returns

Remarks

Exceptions

See Also

Response(Command, int, Bundle)

Declaration

Parameters

Exceptions

See Also

Response(Command, int)

Declaration

Parameters

Exceptions

See Also

SetAgeRating(int)

Declaration

Parameters

Exceptions

See Also

SetIconPath(string)

Declaration

Parameters

Exceptions

See Also

SetIndexOfCurrentPlayingMedia(string)

Declaration

Parameters

Exceptions

See Also

SetInfoOfCurrentPlayingMedia(string, string)

Declaration

Parameters

Exceptions

See Also

SetMetadata(MediaControlMetadata)

Declaration

Parameters

Exceptions

See Also

SetPlaybackCapabilities(Dictionary<MediaControlPlaybackCommand, MediaControlCapabilitySupport>)

Declaration

Parameters

Exceptions

See Also

SetPlaybackCapability(MediaControlPlaybackCommand, MediaControlCapabilitySupport)

Declaration

Parameters

Exceptions

See Also

SetPlaybackContentType(MediaControlContentType)

Declaration

Parameters

Exceptions

See Also

SetPlaybackState(MediaControlPlaybackState, long)

Declaration

Parameters

Exceptions

See Also