Class MediaControlServer

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

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.

Methods

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.

Exceptions

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

API Level: 4

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

API Level: 4

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.

Exceptions

Type	Condition
System.InvalidOperationException	The server is not running . -or- An internal error occurs.
System.ArgumentException	`mode` is invalid.

API Level: 4

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.

Exceptions

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

API Level: 4

View Source

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

PlaybackCommandReceived

Occurs when a client sends playback command.

Declaration


                C#
                
                    Copy
                    
                
            
public static event EventHandler<PlaybackCommandReceivedEventArgs> PlaybackCommandReceived

Event Type

Type	Description
System.EventHandler<PlaybackCommandReceivedEventArgs>

Class MediaControlServer

Definition

Properties

IsRunning

Declaration

Property Value

See Also

API Level: 4

Methods

SetMetadata(MediaControlMetadata)

Declaration

Parameters

Exceptions

API Level: 4

SetPlaybackState(MediaControlPlaybackState, Int64)

Declaration

Parameters

Exceptions

API Level: 4

SetRepeatMode(MediaControlRepeatMode)

Declaration

Parameters

Exceptions

API Level: 4

SetShuffleModeEnabled(Boolean)

Declaration

Parameters

Exceptions

API Level: 4

Start()

Declaration

Remarks

Exceptions

See Also

API Level: 4

Privilege Level: public

Privilege: http://tizen.org/privilege/mediacontroller.server

Stop()

Declaration

Remarks

Exceptions

See Also

API Level: 4

Events

PlaybackCommandReceived

Declaration

Event Type

API Level: 4

See Also