Class MediaControlServer

View Source

Definition

Namespace:
Tizen.Multimedia.Remoting
Assembly:
Tizen.Multimedia.Remoting.dll
API Level:
4

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


                
C#

                

                    
Copy

                    

                

            
public static class MediaControlServer : object
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
Boolean

true if the server has started; otherwise, false.
See Also
API Level: 4

Methods

View Source

GetActivatedClients()

Gets the active clients.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static IEnumerable<string> GetActivatedClients()
Returns
Type Description
IEnumerable<String>

the activated client ids.
API Level: 5
View Source

RemovePlaylist(MediaControlPlaylist)

Delete playlist.

Declaration

                
C#

                

                    
Copy

                    

                

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

The name of playlist.
Remarks

Currently, only server can remove the playlist.

API Level: 5
View Source

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
Task<Bundle>

represents the extra data from client and it can be null.
See Also
API Level: 5
View Source

RequestCommandAsync(Command, String)

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

Declaration

                
C#

                

                    
Copy

                    

                

            
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
Task<ValueTuple<Bundle, Int32>>

The type of return value is Tuple.
First item of Tuple represents the and it represents the extra data from client. It can be null.
Second item of Tuple represents the result of each request(command).
See Also
API Level: 8
View Source

Response(Command, Int32)

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.
Int32 result

The result of command.
API Level: 5
View Source

Response(Command, Int32, 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.
Int32 result

The result of command.
Bundle bundle

The extra data.
API Level: 4
View Source

Response(Command, MediaControlResult)

Sends the result of each command.

Declaration

                
C#

                

                    
Copy

                    

                

            
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.
API Level: 8
View Source

Response(Command, MediaControlResult, Bundle)

Sends the result of each command.

Declaration

                
C#

                

                    
Copy

                    

                

            
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.
API Level: 4
View Source

SetAgeRating(Int32)

Sets the age rating of latest played media.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static void SetAgeRating(int ageRating)
Parameters
Type Name Description
Int32 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.
API Level: 5
View Source

SetCustomCommandCapability(MediaControlCapabilitySupport)

Sets the MediaControlCapabilitySupport indicating custom command is supported or not.

Declaration

                
C#

                

                    
Copy

                    

                

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

A value indicating whether the custom command is supported or not.
API Level: 11
View Source

SetDisplayMode(MediaControlDisplayMode)

Sets the display mode.

Declaration

                
C#

                

                    
Copy

                    

                

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

A value indicating the MediaControlDisplayMode.
API Level: 6
View Source

SetDisplayModeCapabilities(IDictionary<MediaControlDisplayMode, MediaControlCapabilitySupport>)

Sets the supported list of MediaControlDisplayMode.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static void SetDisplayModeCapabilities(IDictionary<MediaControlDisplayMode, MediaControlCapabilitySupport> capabilities)
Parameters
Type Name Description
IDictionary<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.

API Level: 4
View Source

SetDisplayModeCapability(MediaControlDisplayMode, MediaControlCapabilitySupport)

Sets the mode is supported or not.

Declaration

                
C#

                

                    
Copy

                    

                

            
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.

API Level: 6
View Source

SetDisplayRotation(Rotation)

Sets the display rotation.

Declaration

                
C#

                

                    
Copy

                    

                

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

A value indicating the Rotation.
API Level: 6
View Source

SetDisplayRotationCapabilities(IDictionary<Rotation, MediaControlCapabilitySupport>)

Sets the supported list of Rotation.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static void SetDisplayRotationCapabilities(IDictionary<Rotation, MediaControlCapabilitySupport> capabilities)
Parameters
Type Name Description
IDictionary<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.

API Level: 4
View Source

SetDisplayRotationCapability(Rotation, MediaControlCapabilitySupport)

Sets the rotation is supported or not.

Declaration

                
C#

                

                    
Copy

                    

                

            
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.

API Level: 6
View Source

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.
API Level: 5
View Source

SetIndexOfCurrentPlayingMedia(String)

Sets the index of current playing media.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static void SetIndexOfCurrentPlayingMedia(string index)
Parameters
Type Name Description
String index

The index of current playing media.
API Level: 5
View Source

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.
API Level: 5
View Source

SetMetadata(MediaControlMetadata)

Updates metadata information.

Declaration

                
C#

                

                    
Copy

                    

                

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

The metadata to update.
API Level: 4
View Source

SetMode360(Boolean)

Sets the 360 mode.

Declaration

                
C#

                

                    
Copy

                    

                

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

A value indicating whether the 360 mode is enabled.
API Level: 6
View Source

SetMode360Capability(MediaControlCapabilitySupport)

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

Declaration

                
C#

                

                    
Copy

                    

                

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

A value indicating whether the 360 mode is supported or not.
API Level: 6
View Source

SetPlaybackCapabilities(Dictionary<MediaControlPlaybackCommand, MediaControlCapabilitySupport>)

Sets the capabilities by MediaControlPlaybackCommand.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static void SetPlaybackCapabilities(Dictionary<MediaControlPlaybackCommand, MediaControlCapabilitySupport> capabilities)
Parameters
Type Name Description
Dictionary<MediaControlPlaybackCommand, MediaControlCapabilitySupport> capabilities

The set of MediaControlPlaybackCommand and MediaControlCapabilitySupport.
API Level: 4
View Source

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.
API Level: 5
View Source

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.
API Level: 5
View Source

SetPlaybackPositionCapability(MediaControlCapabilitySupport)

Sets the MediaControlCapabilitySupport indicating playback position is supported or not.

Declaration

                
C#

                

                    
Copy

                    

                

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

A value indicating whether the playback position is supported or not.
API Level: 11
View Source

SetPlaybackState(MediaControlPlaybackState, Int64)

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.
Int64 position

The playback position in milliseconds.
API Level: 4
View Source

SetPlaylistCapability(MediaControlCapabilitySupport)

Sets the MediaControlCapabilitySupport indicating playlist is supported or not.

Declaration

                
C#

                

                    
Copy

                    

                

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

A value indicating whether the playlist is supported or not.
API Level: 11
View Source

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.
API Level: 4
View Source

SetRepeatModeCapability(MediaControlCapabilitySupport)

Sets the MediaControlCapabilitySupport indicating repeat mode is supported or not.

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.
API Level: 5
View Source

SetSearchCapability(MediaControlCapabilitySupport)

Sets the MediaControlCapabilitySupport indicating search is supported or not.

Declaration

                
C#

                

                    
Copy

                    

                

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

A value indicating whether the search is supported or not.
API Level: 11
View Source

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.
API Level: 5
View Source

SetShuffleModeEnabled(Boolean)

Updates the shuffle mode.

Declaration

                
C#

                

                    
Copy

                    

                

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

A value indicating whether the shuffle mode is enabled.
API Level: 4
View Source

SetSubtitleMode(Boolean)

Sets the subtitle mode.

Declaration

                
C#

                

                    
Copy

                    

                

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

A value indicating whether the subtitle mode is enabled.
API Level: 6
View Source

SetSubtitleModeCapability(MediaControlCapabilitySupport)

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

Declaration

                
C#

                

                    
Copy

                    

                

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

A value indicating whether the subtitle mode is supported or not.
API Level: 6
View Source

Start()

Starts the media control server.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static void Start()
Remarks

When the server starts, ServerStarted will be raised.

See Also
API Level: 4
Privilege Level: public
Privilege: http://tizen.org/privilege/mediacontroller.server
View Source

Stop()

Stops the media control server.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static void Stop()
Remarks

When the server stops, ServerStopped will be raised.

See Also
API Level: 4

Events

View Source

CustomCommandReceived

Occurs when a client sends custom command.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static event EventHandler<CustomCommandReceivedEventArgs> CustomCommandReceived
Event Type
Type Description
EventHandler<CustomCommandReceivedEventArgs>
API Level: 5
View Source

DisplayModeCommandReceived

Occurs when a client sends display mode command.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static event EventHandler<DisplayModeCommandReceivedEventArgs> DisplayModeCommandReceived
Event Type
Type Description
EventHandler<DisplayModeCommandReceivedEventArgs>
API Level: 6
View Source

DisplayRotationCommandReceived

Occurs when a client sends display rotation command.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static event EventHandler<DisplayRotationCommandReceivedEventArgs> DisplayRotationCommandReceived
Event Type
Type Description
EventHandler<DisplayRotationCommandReceivedEventArgs>
API Level: 6
View Source

Mode360CommandReceived

Occurs when a client sends mode 360 command.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static event EventHandler<Mode360CommandReceivedEventArgs> Mode360CommandReceived
Event Type
Type Description
EventHandler<Mode360CommandReceivedEventArgs>
API Level: 6
View Source

PlaybackActionCommandReceived

Occurs when a client sends playback command.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static event EventHandler<PlaybackActionCommandReceivedEventArgs> PlaybackActionCommandReceived
Event Type
Type Description
EventHandler<PlaybackActionCommandReceivedEventArgs>
API Level: 5
View Source

PlaybackCommandReceived

Occurs when a client sends playback command.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static event EventHandler<PlaybackCommandReceivedEventArgs> PlaybackCommandReceived
Event Type
Type Description
EventHandler<PlaybackCommandReceivedEventArgs>
API Level: 4
View Source

PlaybackPositionCommandReceived

Occurs when a client sends playback position command.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static event EventHandler<PlaybackPositionCommandReceivedEventArgs> PlaybackPositionCommandReceived
Event Type
Type Description
EventHandler<PlaybackPositionCommandReceivedEventArgs>
API Level: 5
View Source

PlaylistCommandReceived

Occurs when a client sends playlist command.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static event EventHandler<PlaylistCommandReceivedEventArgs> PlaylistCommandReceived
Event Type
Type Description
EventHandler<PlaylistCommandReceivedEventArgs>
API Level: 5
View Source

RepeatModeCommandReceived

Occurs when a client sends repeat mode command.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static event EventHandler<RepeatModeCommandReceivedEventArgs> RepeatModeCommandReceived
Event Type
Type Description
EventHandler<RepeatModeCommandReceivedEventArgs>
API Level: 5
View Source

SearchCommandReceived

Occurs when a client sends search command.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static event EventHandler<SearchCommandReceivedEventArgs> SearchCommandReceived
Event Type
Type Description
EventHandler<SearchCommandReceivedEventArgs>
API Level: 5
View Source

ShuffleModeCommandReceived

Occurs when a client sends shuffle mode command.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static event EventHandler<ShuffleModeCommandReceivedEventArgs> ShuffleModeCommandReceived
Event Type
Type Description
EventHandler<ShuffleModeCommandReceivedEventArgs>
API Level: 5
View Source

SubtitleModeCommandReceived

Occurs when a client sends subtitle mode command.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static event EventHandler<SubtitleModeCommandReceivedEventArgs> SubtitleModeCommandReceived
Event Type
Type Description
EventHandler<SubtitleModeCommandReceivedEventArgs>
API Level: 6

See Also