Class MediaController

View Source

Definition

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

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


                
C#

                

                    
Copy

                    

                

            
public class MediaController : object
Inheritance
Object
MediaController

Properties

View Source

IsStopped

Gets a value indicating whether the sever has been stopped.

Declaration

                
C#

                

                    
Copy

                    

                

            
public bool IsStopped { get; }
Property Value
Type Description
Boolean

true if the server has been stopped; otherwise, false.
API Level: 4
View Source

ServerAppId

Gets the application id of the server.

Declaration

                
C#

                

                    
Copy

                    

                

            
public string ServerAppId { get; }
Property Value
Type Description
String

The server application id.
API Level: 4

Methods

View Source

GetAgeRatingOfCurrentPlayingMedia()

Gets the age rating of current playing media.

Declaration

                
C#

                

                    
Copy

                    

                

            
public int GetAgeRatingOfCurrentPlayingMedia()
Returns
Type Description
Int32

The Age rating of current playing media. The range is 0 to 19, inclusive.
API Level: 5
View Source

GetContentTypeOfCurrentPlayingMedia()

Gets the content type of current playing media.

Declaration

                
C#

                

                    
Copy

                    

                

            
public MediaControlContentType GetContentTypeOfCurrentPlayingMedia()
Returns
Type Description
MediaControlContentType

The MediaControlContentType.
API Level: 5
View Source

GetCustomCommandCapability()

Gets the value whether the custom command is supported or not.

Declaration

                
C#

                

                    
Copy

                    

                

            
public MediaControlCapabilitySupport GetCustomCommandCapability()
Returns
Type Description
MediaControlCapabilitySupport

A MediaControlCapabilitySupport.
API Level: 11
View Source

GetDisplayMode()

Gets the current display mode.

Declaration

                
C#

                

                    
Copy

                    

                

            
public MediaControlDisplayMode GetDisplayMode()
Returns
Type Description
MediaControlDisplayMode

The MediaControlDisplayMode.
API Level: 6
View Source

GetDisplayModeCapability()

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

Declaration

                
C#

                

                    
Copy

                    

                

            
public IEnumerable<MediaControlDisplayMode> GetDisplayModeCapability()
Returns
Type Description
IEnumerable<MediaControlDisplayMode>

If there's no supported display mode by server, it will return null. otherwise, it will return the supported list of MediaControlDisplayMode.
API Level: 6
View Source

GetDisplayRotation()

Gets the current display rotation.

Declaration

                
C#

                

                    
Copy

                    

                

            
public Rotation GetDisplayRotation()
Returns
Type Description
Rotation

The Rotation.
API Level: 6
View Source

GetDisplayRotationCapability()

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

Declaration

                
C#

                

                    
Copy

                    

                

            
public IEnumerable<Rotation> GetDisplayRotationCapability()
Returns
Type Description
IEnumerable<Rotation>

If there's no supported display rotation by server, it will return null. otherwise, it will return the supported list of Rotation.
API Level: 6
View Source

GetIconPath()

Gets the icon path.

Declaration

                
C#

                

                    
Copy

                    

                

            
public string GetIconPath()
Returns
Type Description
String

The icon path.
API Level: 5
View Source

GetIndexOfCurrentPlayingMedia()

Returns the index of current playing media.

Declaration

                
C#

                

                    
Copy

                    

                

            
public string GetIndexOfCurrentPlayingMedia()
Returns
Type Description
String

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

GetMetadata()

Returns the metadata set by the server.

Declaration

                
C#

                

                    
Copy

                    

                

            
public MediaControlMetadata GetMetadata()
Returns
Type Description
MediaControlMetadata

The metadata.
See Also
API Level: 4
View Source

GetMode360Capability()

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

Declaration

                
C#

                

                    
Copy

                    

                

            
public MediaControlCapabilitySupport GetMode360Capability()
Returns
Type Description
MediaControlCapabilitySupport

A MediaControlCapabilitySupport.
API Level: 6
View Source

GetPlaybackCapabilities()

Gets the value whether MediaControlPlaybackCommand is supported or not.

Declaration

                
C#

                

                    
Copy

                    

                

            
public Dictionary<MediaControlPlaybackCommand, MediaControlCapabilitySupport> GetPlaybackCapabilities()
Returns
Type Description
Dictionary<MediaControlPlaybackCommand, MediaControlCapabilitySupport>

the set of MediaControlPlaybackCommand and MediaControlCapabilitySupport.
API Level: 5
View Source

GetPlaybackCapability(MediaControlPlaybackCommand)

Gets the value whether action is supported or not.

Declaration

                
C#

                

                    
Copy

                    

                

            
public MediaControlCapabilitySupport GetPlaybackCapability(MediaControlPlaybackCommand action)
Parameters
Type Name Description
MediaControlPlaybackCommand action

A playback command.
Returns
Type Description
MediaControlCapabilitySupport

A MediaControlCapabilitySupport.
API Level: 5
View Source

GetPlaybackPosition()

Returns the playback position set by the server.

Declaration

                
C#

                

                    
Copy

                    

                

            
public long GetPlaybackPosition()
Returns
Type Description
Int64

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

GetPlaybackPositionCapability()

Gets the value whether the playback position is supported or not.

Declaration

                
C#

                

                    
Copy

                    

                

            
public MediaControlCapabilitySupport GetPlaybackPositionCapability()
Returns
Type Description
MediaControlCapabilitySupport

A MediaControlCapabilitySupport.
API Level: 11
View Source

GetPlaybackState()

Returns the playback state set by the server.

Declaration

                
C#

                

                    
Copy

                    

                

            
public MediaControlPlaybackState GetPlaybackState()
Returns
Type Description
MediaControlPlaybackState

The playback state.
See Also
API Level: 4
View Source

GetPlaylistCapability()

Gets the value whether the playlist is supported or not.

Declaration

                
C#

                

                    
Copy

                    

                

            
public MediaControlCapabilitySupport GetPlaylistCapability()
Returns
Type Description
MediaControlCapabilitySupport

A MediaControlCapabilitySupport.
API Level: 11
View Source

GetPlaylistOfCurrentPlayingMedia()

Returns the playlist name of current playing media.

Declaration

                
C#

                

                    
Copy

                    

                

            
public MediaControlPlaylist GetPlaylistOfCurrentPlayingMedia()
Returns
Type Description
MediaControlPlaylist

The playlist name.
API Level: 5
View Source

GetPlaylists()

Returns the all playlists.

Declaration

                
C#

                

                    
Copy

                    

                

            
public IEnumerable<MediaControlPlaylist> GetPlaylists()
Returns
Type Description
IEnumerable<MediaControlPlaylist>

The set of MediaControlPlaylist.
API Level: 5
View Source

GetRepeatMode()

Returns the repeat mode.

Declaration

                
C#

                

                    
Copy

                    

                

            
public MediaControlRepeatMode GetRepeatMode()
Returns
Type Description
MediaControlRepeatMode

A MediaControlRepeatMode set by the server.
See Also
API Level: 4
View Source

GetRepeatModeCapability()

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

Declaration

                
C#

                

                    
Copy

                    

                

            
public MediaControlCapabilitySupport GetRepeatModeCapability()
Returns
Type Description
MediaControlCapabilitySupport

A MediaControlCapabilitySupport.
API Level: 5
View Source

GetSearchCapability()

Gets the value whether the search is supported or not.

Declaration

                
C#

                

                    
Copy

                    

                

            
public MediaControlCapabilitySupport GetSearchCapability()
Returns
Type Description
MediaControlCapabilitySupport

A MediaControlCapabilitySupport.
API Level: 11
View Source

GetShuffleModeCapability()

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

Declaration

                
C#

                

                    
Copy

                    

                

            
public MediaControlCapabilitySupport GetShuffleModeCapability()
Returns
Type Description
MediaControlCapabilitySupport

A MediaControlCapabilitySupport.
API Level: 5
View Source

GetSubtitleModeCapability()

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

Declaration

                
C#

                

                    
Copy

                    

                

            
public MediaControlCapabilitySupport GetSubtitleModeCapability()
Returns
Type Description
MediaControlCapabilitySupport

A MediaControlCapabilitySupport.
API Level: 6
View Source

IsMode360Enabled()

Gets whether the 360 mode is enabled or not.

Declaration

                
C#

                

                    
Copy

                    

                

            
public bool IsMode360Enabled()
Returns
Type Description
Boolean

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

IsShuffleModeEnabled()

Returns whether the shuffle mode is enabled.

Declaration

                
C#

                

                    
Copy

                    

                

            
public bool IsShuffleModeEnabled()
Returns
Type Description
Boolean

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

IsSubtitleModeEnabled()

Gets whether the subtitle mode is enabled or not.

Declaration

                
C#

                

                    
Copy

                    

                

            
public bool IsSubtitleModeEnabled()
Returns
Type Description
Boolean

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

RequestAsync(Command)

Requests command to the server.

Declaration

                
C#

                

                    
Copy

                    

                

            
public Task<Bundle> RequestAsync(Command command)
Parameters
Type Name Description
Command command

A Command class.
Returns
Type Description
Task<Bundle>

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

RequestCommandAsync(Command)

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

Declaration

                
C#

                

                    
Copy

                    

                

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

A Command class.
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 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 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 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 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

SendPlaybackCommand(MediaControlPlaybackCommand)

Sends playback command to the server.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void SendPlaybackCommand(MediaControlPlaybackCommand command)
Parameters
Type Name Description
MediaControlPlaybackCommand command

A playback command.
See Also
API Level: 4

Events

View Source

CustomCommandCapabilityUpdated

Occurs when the custom command capability is updated.

Declaration

                
C#

                

                    
Copy

                    

                

            
public event EventHandler<CustomCommandCapabilityUpdatedEventArgs> CustomCommandCapabilityUpdated
Event Type
Type Description
EventHandler<CustomCommandCapabilityUpdatedEventArgs>
API Level: 11
View Source

CustomCommandReceived

Occurs when a server sends custom event.

Declaration

                
C#

                

                    
Copy

                    

                

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

DisplayModeCapabilityUpdated

Occurs when the display mode capability is updated.

Declaration

                
C#

                

                    
Copy

                    

                

            
public event EventHandler<DisplayModeCapabilityUpdatedEventArgs> DisplayModeCapabilityUpdated
Event Type
Type Description
EventHandler<DisplayModeCapabilityUpdatedEventArgs>
API Level: 6
View Source

DisplayModeUpdated

Occurs when the display mode is updated.

Declaration

                
C#

                

                    
Copy

                    

                

            
public event EventHandler<DisplayModeUpdatedEventArgs> DisplayModeUpdated
Event Type
Type Description
EventHandler<DisplayModeUpdatedEventArgs>
API Level: 6
View Source

DisplayRotationCapabilityUpdated

Occurs when the display rotation capability is updated.

Declaration

                
C#

                

                    
Copy

                    

                

            
public event EventHandler<DisplayRotationCapabilityUpdatedEventArgs> DisplayRotationCapabilityUpdated
Event Type
Type Description
EventHandler<DisplayRotationCapabilityUpdatedEventArgs>
API Level: 6
View Source

DisplayRotationUpdated

Occurs when the display rotation is updated.

Declaration

                
C#

                

                    
Copy

                    

                

            
public event EventHandler<DisplayRotationUpdatedEventArgs> DisplayRotationUpdated
Event Type
Type Description
EventHandler<DisplayRotationUpdatedEventArgs>
API Level: 6
View Source

MetadataUpdated

Occurs when the metadata is updated.

Declaration

                
C#

                

                    
Copy

                    

                

            
public event EventHandler<MetadataUpdatedEventArgs> MetadataUpdated
Event Type
Type Description
EventHandler<MetadataUpdatedEventArgs>
API Level: 4
View Source

Mode360CapabilityUpdated

Occurs when the mode360 capability is updated.

Declaration

                
C#

                

                    
Copy

                    

                

            
public event EventHandler<Mode360CapabilityUpdatedEventArgs> Mode360CapabilityUpdated
Event Type
Type Description
EventHandler<Mode360CapabilityUpdatedEventArgs>
API Level: 11
View Source

Mode360Updated

Occurs when the 360 mode is updated.

Declaration

                
C#

                

                    
Copy

                    

                

            
public event EventHandler<Mode360UpdatedEventArgs> Mode360Updated
Event Type
Type Description
EventHandler<Mode360UpdatedEventArgs>
API Level: 6
View Source

PlaybackCapabilityUpdated

Occurs when the playback capabilities are updated.

Declaration

                
C#

                

                    
Copy

                    

                

            
public event EventHandler<PlaybackCapabilityUpdatedEventArgs> PlaybackCapabilityUpdated
Event Type
Type Description
EventHandler<PlaybackCapabilityUpdatedEventArgs>
API Level: 5
View Source

PlaybackPositionCapabilityUpdated

Occurs when the playback position capability is updated.

Declaration

                
C#

                

                    
Copy

                    

                

            
public event EventHandler<PlaybackPositionCapabilityUpdatedEventArgs> PlaybackPositionCapabilityUpdated
Event Type
Type Description
EventHandler<PlaybackPositionCapabilityUpdatedEventArgs>
API Level: 11
View Source

PlaybackStateUpdated

Occurs when the playback state is updated.

Declaration

                
C#

                

                    
Copy

                    

                

            
public event EventHandler<PlaybackStateUpdatedEventArgs> PlaybackStateUpdated
Event Type
Type Description
EventHandler<PlaybackStateUpdatedEventArgs>
API Level: 4
View Source

PlaylistCapabilityUpdated

Occurs when the playlist capability is updated.

Declaration

                
C#

                

                    
Copy

                    

                

            
public event EventHandler<PlaylistCapabilityUpdatedEventArgs> PlaylistCapabilityUpdated
Event Type
Type Description
EventHandler<PlaylistCapabilityUpdatedEventArgs>
API Level: 11
View Source

PlaylistUpdated

Occurs when the playlist is updated.

Declaration

                
C#

                

                    
Copy

                    

                

            
public event EventHandler<PlaylistUpdatedEventArgs> PlaylistUpdated
Event Type
Type Description
EventHandler<PlaylistUpdatedEventArgs>
API Level: 5
View Source

RepeatModeCapabilityUpdated

Occurs when the repeat mode capability is updated.

Declaration

                
C#

                

                    
Copy

                    

                

            
public event EventHandler<RepeatModeCapabilityUpdatedEventArgs> RepeatModeCapabilityUpdated
Event Type
Type Description
EventHandler<RepeatModeCapabilityUpdatedEventArgs>
API Level: 5
View Source

RepeatModeUpdated

Occurs when the repeat mode is updated.

Declaration

                
C#

                

                    
Copy

                    

                

            
public event EventHandler<RepeatModeUpdatedEventArgs> RepeatModeUpdated
Event Type
Type Description
EventHandler<RepeatModeUpdatedEventArgs>
API Level: 4
View Source

SearchCapabilityUpdated

Occurs when the search capability is updated.

Declaration

                
C#

                

                    
Copy

                    

                

            
public event EventHandler<SearchCapabilityUpdatedEventArgs> SearchCapabilityUpdated
Event Type
Type Description
EventHandler<SearchCapabilityUpdatedEventArgs>
API Level: 11
View Source

ServerStopped

Occurs when the server is stopped.

Declaration

                
C#

                

                    
Copy

                    

                

            
public event EventHandler ServerStopped
Event Type
Type Description
EventHandler
API Level: 4
View Source

ShuffleModeCapabilityUpdated

Occurs when the shuffle mode capability is updated.

Declaration

                
C#

                

                    
Copy

                    

                

            
public event EventHandler<ShuffleModeCapabilityUpdatedEventArgs> ShuffleModeCapabilityUpdated
Event Type
Type Description
EventHandler<ShuffleModeCapabilityUpdatedEventArgs>
API Level: 5
View Source

ShuffleModeUpdated

Occurs when the shuffle mode is updated.

Declaration

                
C#

                

                    
Copy

                    

                

            
public event EventHandler<ShuffleModeUpdatedEventArgs> ShuffleModeUpdated
Event Type
Type Description
EventHandler<ShuffleModeUpdatedEventArgs>
API Level: 4
View Source

SubtitleCapabilityUpdated

Occurs when the subtitle capability is updated.

Declaration

                
C#

                

                    
Copy

                    

                

            
public event EventHandler<SubtitleCapabilityUpdatedEventArgs> SubtitleCapabilityUpdated
Event Type
Type Description
EventHandler<SubtitleCapabilityUpdatedEventArgs>
API Level: 11
View Source

SubtitleModeUpdated

Occurs when the subtitle mode is updated.

Declaration

                
C#

                

                    
Copy

                    

                

            
public event EventHandler<SubtitleModeUpdatedEventArgs> SubtitleModeUpdated
Event Type
Type Description
EventHandler<SubtitleModeUpdatedEventArgs>
API Level: 6

Extension Methods