C# Class SV.UPnPLite.Protocols.DLNA.Services.AvTransport.AvTransportService

Enables control over the transport of audio and video streams. The service type defines a ‘common’ model for A/V transport control suitable for a generic user interface. It can be used to control a wide variety of disc, tape and solid-state based media devices such as CD players, VCRs and MP3 players.

Inheritance: SV.UPnPLite.Protocols.UPnP.UPnPService, IAvTransportService

Show file Open project: SNIKO/UPnPLite

Public Methods

Method	Description
AvTransportService ( string serviceType, Uri controlUri, Uri eventsUri ) : SV.UPnPLite.Extensions	Initializes a new instanceId of the AvTransportService class.
AvTransportService ( string serviceType, Uri controlUri, Uri eventsUri, ILogManager logManager ) : SV.UPnPLite.Extensions	Initializes a new instanceId of the AvTransportService class.
GetMediaInfoAsync ( uint instanceId ) : Task	Returns information associated with the current media of the specified instance.
GetPositionInfoAsync ( uint instanceId ) : Task	Returns information associated with the current position of the transport of the specified instance.
GetTransportInfoAsync ( uint instanceId ) : Task	Returns information associated with the current transport state of the specified instance.
PauseAsync ( uint instanceId ) : System.Threading.Tasks.Task	Halts the progression of the resource that is associated with the specified instance.
PlayAsync ( uint instanceId, string speed ) : System.Threading.Tasks.Task	Starts playing the resource of the specified instanceId, at the specified speed, starting at the current position, according to the current play mode.
SetAvTransportURIAsync ( uint instanceId, string currentUri, string currentUriMetadata ) : System.Threading.Tasks.Task	Specifies the URI of the resource to be controlled by the specified AVTransport instance.
SetNextAvTransportURIAsync ( uint instanceId, string nextUri, string nextUriMetadata ) : System.Threading.Tasks.Task	Specifies the URI of the resource to be controlled when the playback of the current resource (set earlier via SetAvTransportURIAsync) finishes.
StopAsync ( uint instanceId ) : System.Threading.Tasks.Task	Stops the progression of the current resource that is associated with the specified instance.

Method Details

AvTransportService() public method

Initializes a new instanceId of the AvTransportService class.

/// is null or -OR- /// is null -OR- /// is null. ///

public AvTransportService ( string serviceType, Uri controlUri, Uri eventsUri ) : SV.UPnPLite.Extensions
serviceType	string	/// A type of the service. ///
controlUri	System.Uri	/// An URL for sending commands to the service. ///
eventsUri	System.Uri	/// An URL for subscrinbing to service's events. ///
return	SV.UPnPLite.Extensions

AvTransportService() public method

Initializes a new instanceId of the AvTransportService class.

/// is null or -OR- /// is null -OR- /// is null -OR- /// is null. ///

public AvTransportService ( string serviceType, Uri controlUri, Uri eventsUri, ILogManager logManager ) : SV.UPnPLite.Extensions
serviceType	string	/// A type of the service. ///
controlUri	System.Uri	/// An URL for sending commands to the service. ///
eventsUri	System.Uri	/// An URL for subscrinbing to service's events. ///
logManager	ILogManager	/// The to use for logging the debug information. ///
return	SV.UPnPLite.Extensions

GetMediaInfoAsync() public method

Returns information associated with the current media of the specified instance.

/// An error occurred when sending request to service. /// /// Received result is in a bad format. /// /// An internal service error occurred when executing request. ///

public GetMediaInfoAsync ( uint instanceId ) : Task
instanceId	uint	/// Identifies the virtual instanceId of the AVTransport service to which the action applies. ///
return	Task

GetPositionInfoAsync() public method

Returns information associated with the current position of the transport of the specified instance.

/// An error occurred when sending request to service. /// /// Received result is in a bad format. /// /// An internal service error occurred when executing request. ///

public GetPositionInfoAsync ( uint instanceId ) : Task
instanceId	uint	/// Identifies the virtual instanceId of the AVTransport service to which the action applies. ///
return	Task

GetTransportInfoAsync() public method

Returns information associated with the current transport state of the specified instance.

/// An error occurred when sending request to service. /// /// Received result is in a bad format. /// /// An internal service error occurred when executing request. ///

public GetTransportInfoAsync ( uint instanceId ) : Task
instanceId	uint	/// Identifies the virtual instanceId of the AVTransport service to which the action applies. ///
return	Task

PauseAsync() public method

Halts the progression of the resource that is associated with the specified instance.

/// An error occurred when sending request to service. /// /// An internal service error occurred when executing request. ///

public PauseAsync ( uint instanceId ) : System.Threading.Tasks.Task
instanceId	uint	/// Identifies the virtual instanceId of the AVTransport service to which the action applies. ///
return	System.Threading.Tasks.Task

PlayAsync() public method

Starts playing the resource of the specified instanceId, at the specified speed, starting at the current position, according to the current play mode.

/// An error occurred when sending request to service. /// /// An internal service error occurred when executing request. ///

public PlayAsync ( uint instanceId, string speed ) : System.Threading.Tasks.Task
instanceId	uint	/// Identifies the virtual instanceId of the AVTransport service to which the action applies. ///
speed	string	/// Indicates the speed relative to normal speed. Example values are ‘1’, ‘1/2’, ‘2’, ‘-1’, ‘1/10’, etc. ///
return	System.Threading.Tasks.Task

SetAvTransportURIAsync() public method

Specifies the URI of the resource to be controlled by the specified AVTransport instance.

/// is null. /// /// An error occurred when sending request to service. /// /// Received result is in a bad format. /// /// An unexpected error occurred when executing request on service. ///

public SetAvTransportURIAsync ( uint instanceId, string currentUri, string currentUriMetadata ) : System.Threading.Tasks.Task
instanceId	uint	/// Identifies the virtual instanceId of the AVTransport service to which the action applies. ///
currentUri	string	/// The URI to the resource to control. ///
currentUriMetadata	string	/// The metadata, in the form of a DIDL-Lite XML fragment, associated with the resource pointed by . ///
return	System.Threading.Tasks.Task

SetNextAvTransportURIAsync() public method

Specifies the URI of the resource to be controlled when the playback of the current resource (set earlier via SetAvTransportURIAsync) finishes.

/// is null. /// /// An error occurred when sending request to service. /// /// Received result is in a bad format. /// /// An internal service error occurred when executing request. ///

public SetNextAvTransportURIAsync ( uint instanceId, string nextUri, string nextUriMetadata ) : System.Threading.Tasks.Task
instanceId	uint	/// Identifies the virtual instanceId of the AVTransport service to which the action applies. ///
nextUri	string	/// The URI to the next resource to control. ///
nextUriMetadata	string	/// The metadata, in the form of a DIDL-Lite XML fragment, associated with the resource pointed by . ///
return	System.Threading.Tasks.Task

StopAsync() public method

Stops the progression of the current resource that is associated with the specified instance.

/// An error occurred when sending request to service. /// /// An internal service error occurred when executing request. ///

public StopAsync ( uint instanceId ) : System.Threading.Tasks.Task
instanceId	uint	/// Identifies the virtual instanceId of the AVTransport service to which the action applies. ///
return	System.Threading.Tasks.Task