From OpenHome

(Difference between revisions)

Revision as of 15:06, 1 May 2017

Transport Service

Overview

The Transport service provides source-independent control of play, pause, stop, skip and seek.

If a device's Product service reports an attribute "Transport", then that device is guaranteed to bear the Transport service. If the Transport service is available, all its properties and actions must be fully implemented.

Evented Properties

Modes

Space separated list of available modes.

CanSkipNext

true if the SkipNext action is currently available; false otherwise.

Any mode that is sometimes capable of changing stream as a consequence of SkipNext will always report CanSkipNext as true.

CanSkipPrevious

true if the SkipPrevious action is currently available; false otherwise.

Any mode that is sometimes capable of changing stream as a consequence of SkipPrevious will always report CanSkipPrevious as true.

CanRepeat

true if the SetRepeat action is currently available; false otherwise.

CanShuffle

true if the SetShuffle action is currently available; false otherwise.

StreamId

Integer id, uniquely identifying the current stream.

CanSeek

true if the SeekSecondAbsolute and SeekSecondRelative actions are available for the current stream; false otherwise.

CanPause

true if the stream can be paused (so is not being played at a rate determined by a remote sender); false otherwise.

TransportState

One of

Playing
Paused
Stopped
Buffering
Waiting

Repeat

true if repeat mode is currently enabled; false otherwise.

Shuffle

true if shuffle mode is currently enabled; false otherwise.

Actions

PlayAs

Arguments: (in string mode, in string command)
Start a new stream playing, specifying both a mode (source) to be used and a mode-specific command which describes the track to be played. Common options for modes and commands are documented separately.

Play

Arguments: None
Start a pending stream playing.

A stream must be ready to play. Possibly via calls to another network service.

Behaviour when a stream is already playing varies depending on the active modes (source).

Pause

Arguments: None
Pause the current stream.

Returns a 801 fault code if the current channel does not support being paused (is being played at a rate determined by a remote sender).

Stop

Arguments: None Stop the current stream.

SetRepeat

Arguments: (in uint repeat)
Sets the Repeat state of the device, affecting all sources that are capable of implementing a repeat feature.

SetShuffle

Arguments: (in uint shuffle)
Sets the Shuffle state of the device, affecting all sources that are capable of implementing a randomise feature.

SeekSecondAbsolute

Arguments: (in uint streamId, in uint secondsAbsolute)
Seek to an absolute position in the current stream. If TransportState is Stopped or Paused, try to start playing.

Returns a 801 fault code if the current stream does not support seek. brReturns a 803 fault code if the seek position is beyond the end of the stream.

SeekSecondRelative

Arguments: (in uint streamId, in int secondsRelative)
Seek to a position relative to what's currently playing in the current stream. If TransportState is Stopped or Paused, try to start playing.

Returns a 801 fault code if the current stream does not support seek. brReturns a 803 fault code if the seek position is beyond the end of the stream.

TransportState

Arguments: (out string state)
Read the current value of the TransportState property.

Modes

Arguments: (out string modes)
Return the value of the Modes property.

ModeInfo

Arguments: (out string mode, out bool canSkipNext, out bool canSkipPrevious, out bool canRepeat, out bool canShuffle)
Reports the values of the Mode, CanSkipNext, CanSkipPrev, CanRepeat and CanShuffle properties.

StreamInfo

Arguments: (out uint streamId, out bool seekable, out bool pausable)

Reports current stream information:

StreamId
Seekable
Pausable

StreamId

Arguments: (out uint streamId)
Read the current value of the StreamId property.

Repeat

Arguments: (out uint repeat)
Read the current value of the Repeat property.

Shuffle

Arguments: (out uint shuffle)
Read the current value of the Shuffle property.

UPnP Service Description

For devices supporting the UPnP protocol, the service description is

name: "Transport" domain: "av.openhome.org" version: "1"

<?xml version="1.0" encoding="utf-8"?>
<scpd xmlns="urn:schemas-upnp-org:service-1-0">
  <specVersion>
    <major>1</major>
    <minor>0</minor>
  </specVersion>
  <actionList>
    <action>
      <name>PlayAs</name>
      <argumentList>
        <argument>
          <name>Mode</name>
          <direction>in</direction>
          <relatedStateVariable>A_ARG_TYPE_string</relatedStateVariable>
        </argument>
        <argument>
          <name>Command</name>
          <direction>in</direction>
          <relatedStateVariable>A_ARG_TYPE_string</relatedStateVariable>
        </argument>
      </argumentList>
    </action>
    <action>
      <name>Play</name>
    </action>
    <action>
      <name>Pause</name>
    </action>
    <action>
      <name>Stop</name>
    </action>
    <action>
      <name>SkipNext</name>
    </action>
    <action>
      <name>SkipPrevious</name>
    </action>
    <action>
      <name>SetRepeat</name>
      <argumentList>
        <argument>
          <name>Repeat</name>
          <direction>in</direction>
          <relatedStateVariable>Repeat</relatedStateVariable>
        </argument>
      </argumentList>
    </action>
    <action>
      <name>SetShuffle</name>
      <argumentList>
        <argument>
          <name>Shuffle</name>
          <direction>in</direction>
          <relatedStateVariable>Shuffle</relatedStateVariable>
        </argument>
      </argumentList>
    </action>
    <action>
      <name>SeekSecondAbsolute</name>
      <argumentList>
        <argument>
          <name>StreamId</name>
          <direction>in</direction>
          <relatedStateVariable>StreamId</relatedStateVariable>
        </argument>
        <argument>
          <name>SecondAbsolute</name>
          <direction>in</direction>
          <relatedStateVariable>A_ARG_TYPE_uint</relatedStateVariable>
        </argument>
      </argumentList>
    </action>
    <action>
      <name>SeekSecondRelative</name>
      <argumentList>
        <argument>
          <name>StreamId</name>
          <direction>in</direction>
          <relatedStateVariable>StreamId</relatedStateVariable>
        </argument>
        <argument>
          <name>SecondRelative</name>
          <direction>in</direction>
          <relatedStateVariable>A_ARG_TYPE_int</relatedStateVariable>
        </argument>
      </argumentList>
    </action>
    <action>
      <name>TransportState</name>
      <argumentList>
        <argument>
          <name>State</name>
          <direction>out</direction>
          <relatedStateVariable>TransportState</relatedStateVariable>
        </argument>
      </argumentList>
    </action>
    <action>
      <name>Modes</name>
      <argumentList>
        <argument>
          <name>Modes</name>
          <direction>out</direction>
          <relatedStateVariable>Modes</relatedStateVariable>
        </argument>
      </argumentList>
    </action>
    <action>
      <name>ModeInfo</name>
      <argumentList>
        <argument>
          <name>CanSkipNext</name>
          <direction>out</direction>
          <relatedStateVariable>CanSkipNext</relatedStateVariable>
        </argument>
        <argument>
          <name>CanSkipPrevious</name>
          <direction>out</direction>
          <relatedStateVariable>CanSkipPrevious</relatedStateVariable>
        </argument>
        <argument>
          <name>CanRepeat</name>
          <direction>out</direction>
          <relatedStateVariable>CanRepeat</relatedStateVariable>
        </argument>
        <argument>
          <name>CanShuffle</name>
          <direction>out</direction>
          <relatedStateVariable>CanShuffle</relatedStateVariable>
        </argument>
      </argumentList>
    </action>
    <action>
      <name>StreamInfo</name>
      <argumentList>
        <argument>
          <name>StreamId</name>
          <direction>out</direction>
          <relatedStateVariable>StreamId</relatedStateVariable>
        </argument>
        <argument>
          <name>CanSeek</name>
          <direction>out</direction>
          <relatedStateVariable>CanSeek</relatedStateVariable>
        </argument>
        <argument>
          <name>CanPause</name>
          <direction>out</direction>
          <relatedStateVariable>CanPause</relatedStateVariable>
        </argument>
      </argumentList>
    </action>
    <action>
      <name>StreamId</name>
      <argumentList>
        <argument>
          <name>StreamId</name>
          <direction>out</direction>
          <relatedStateVariable>StreamId</relatedStateVariable>
        </argument>
      </argumentList>
    </action>
    <action>
      <name>Repeat</name>
      <argumentList>
        <argument>
          <name>Repeat</name>
          <direction>out</direction>
          <relatedStateVariable>Repeat</relatedStateVariable>
        </argument>
      </argumentList>
    </action>
    <action>
      <name>Shuffle</name>
      <argumentList>
        <argument>
          <name>Shuffle</name>
          <direction>out</direction>
          <relatedStateVariable>Shuffle</relatedStateVariable>
        </argument>
      </argumentList>
    </action>
  </actionList>
  <serviceStateTable>
    <stateVariable sendEvents="yes">
      <name>Modes</name>
      <dataType>string</dataType>
    </stateVariable>
    <stateVariable sendEvents="yes">
      <name>CanSkipNext</name>
      <dataType>boolean</dataType>
    </stateVariable>
    <stateVariable sendEvents="yes">
      <name>CanSkipPrevious</name>
      <dataType>boolean</dataType>
    </stateVariable>
    <stateVariable sendEvents="yes">
      <name>CanRepeat</name>
      <dataType>boolean</dataType>
    </stateVariable>
    <stateVariable sendEvents="yes">
      <name>CanShuffle</name>
      <dataType>boolean</dataType>
    </stateVariable>
    <stateVariable sendEvents="yes">
      <name>StreamId</name>
      <dataType>ui4</dataType>
    </stateVariable>
    <stateVariable sendEvents="yes">
      <name>CanSeek</name>
      <dataType>boolean</dataType>
    </stateVariable>
    <stateVariable sendEvents="yes">
      <name>CanPause</name>
      <dataType>boolean</dataType>
    </stateVariable>
    <stateVariable sendEvents="yes">
      <name>TransportState</name>
      <dataType>string</dataType>
      <allowedValueList>
        <allowedValue>Playing</allowedValue>
        <allowedValue>Paused</allowedValue>
        <allowedValue>Stopped</allowedValue>
        <allowedValue>Buffering</allowedValue>
        <allowedValue>Waiting</allowedValue>
      </allowedValueList>
    </stateVariable>
    <stateVariable sendEvents="yes">
      <name>Repeat</name>
      <dataType>boolean</dataType>
    </stateVariable>
    <stateVariable sendEvents="yes">
      <name>Shuffle</name>
      <dataType>boolean</dataType>
    </stateVariable>
    <stateVariable sendEvents="no">
      <name>A_ARG_TYPE_uint</name>
      <dataType>ui4</dataType>
    </stateVariable>
    <stateVariable sendEvents="no">
      <name>A_ARG_TYPE_int</name>
      <dataType>i4</dataType>
    </stateVariable>
    <stateVariable sendEvents="no">
      <name>A_ARG_TYPE_string</name>
      <dataType>string</dataType>
    </stateVariable>
  </serviceStateTable>
</scpd>

@@ Line 9: / Line 9: @@
 Space separated list of available modes.
-=== NextAvailable ===
+=== CanSkipNext ===
-<tt>true</tt> if the <tt>Next</tt> (skip forwards) action is currently available; <tt>false</tt> otherwise.
+<tt>true</tt> if the <tt>SkipNext</tt> action is currently available; <tt>false</tt> otherwise.
-Any mode that is sometimes capable of changing stream as a consequence of <tt>Next</tt> will always report <tt>NextAvailable</tt> as <tt>true</tt>.
+Any mode that is sometimes capable of changing stream as a consequence of <tt>SkipNext</tt> will always report <tt>CanSkipNext</tt> as <tt>true</tt>.
-=== PreviousAvailable ===
+=== CanSkipPrevious ===
-<tt>true</tt> if the <tt>Previous</tt> (skip backwards) action is currently available; <tt>false</tt> otherwise.
+<tt>true</tt> if the <tt>SkipPrevious</tt> action is currently available; <tt>false</tt> otherwise.
-Any mode that is sometimes capable of changing stream as a consequence of <tt>Prev</tt> will always report <tt>PreviousAvailable</tt> as <tt>true</tt>.
+Any mode that is sometimes capable of changing stream as a consequence of <tt>SkipPrevious</tt> will always report <tt>CanSkipPrevious</tt> as <tt>true</tt>.
-=== RepeatAvailable ===
+=== CanRepeat ===
 <tt>true</tt> if the <tt>SetRepeat</tt> action is currently available; <tt>false</tt> otherwise.
-=== ShuffleAvailable ===
+=== CanShuffle ===
 <tt>true</tt> if the <tt>SetShuffle</tt> action is currently available; <tt>false</tt> otherwise.
@@ Line 28: / Line 28: @@
 Integer id, uniquely identifying the current stream.
-=== Seekable ===
+=== CanSeek ===
 <tt>true</tt> if the <tt>SeekSecondAbsolute</tt> and <tt>SeekSecondRelative</tt> actions are available for the current stream; <tt>false</tt> otherwise.
-=== Pausable ===
+=== CanPause ===
 <tt>true</tt> if the stream can be paused (so is not being played at a rate determined by a remote sender); <tt>false</tt> otherwise.
@@ Line 43: / Line 43: @@
 === Repeat ===
-<tt>0</tt> if repeat mode is currently disabled.
+<tt>true</tt> if repeat mode is currently enabled; <tt>false</tt> otherwise.
-<br><tt>>0</tt> if repeat mode is currently enabled (i.e. playing content will loop endlessly).
-<br>A value of <tt>1</tt> implies that all content available to the current mode will be repeated.  Larger values are reserved for future use and may imply new repeat modes (e.g. repeat a selection of tracks only).
 === Shuffle ===
-<tt>0</tt> if shuffle mode is currently disabled.
+<tt>true</tt> if shuffle mode is currently enabled; <tt>false</tt> otherwise.
-<br><tt>>0</tt> if shuffle mode is currently enabled.
-<br>A value of <tt>1</tt> implies that all content available to the current mode will be shuffled.  Larger values are reserved for future use and may imply new shuffle modes (e.g. play only a single album, randomising its tracks).
 == Actions ==
@@ Line 102: / Line 99: @@
 </tt><br>
 Sets the Repeat state of the device, affecting all sources that are capable of implementing a repeat feature.
-<br>Only states <tt>0</tt> (repeat off) and <tt>1</tt> (repeat on, all tracks) are currently supported.
 === SetShuffle ===
@@ Line 109: / Line 105: @@
 </tt><br>
 Sets the Shuffle state of the device, affecting all sources that are capable of implementing a randomise feature.
-<br>Only states <tt>0</tt> (shuffle off) and <tt>1</tt> (shuffle on, all tracks) are currently supported.
 === SeekSecondAbsolute ===
@@ Line 143: / Line 138: @@
 === ModeInfo ===
 <tt>
-Arguments: (out string mode, out bool nextAvailable, out bool previousAvailable, out bool repeatAvailable, out bool shuffleAvailable)
+Arguments: (out string mode, out bool canSkipNext, out bool canSkipPrevious, out bool canRepeat, out bool canShuffle)
 </tt><br>
-Reports the values of the <tt>Mode</tt>, <tt>NextAvailable</tt>, <tt>PrevAvailable</tt>, <tt>RepeatAvailable</tt> and <tt>ShuffleAvailable</tt> properties.
+Reports the values of the <tt>Mode</tt>, <tt>CanSkipNext</tt>, <tt>CanSkipPrev</tt>, <tt>CanRepeat</tt> and <tt>CanShuffle</tt> properties.
 === StreamInfo ===
@@ Line 215: / Line 210: @@
      </action>
      <action>
-       <name>Next</name>
+       <name>SkipNext</name>
      </action>
      <action>
-       <name>Prev</name>
+       <name>SkipPrevious</name>
      </action>
      <action>
@@ Line 226: / Line 221: @@
            <name>Repeat</name>
            <direction>in</direction>
-           <relatedStateVariable>A_ARG_TYPE_boolean</relatedStateVariable>
+           <relatedStateVariable>Repeat</relatedStateVariable>
          </argument>
        </argumentList>
      </action>
      <action>
-       <name>SetRandom</name>
+       <name>SetShuffle</name>
        <argumentList>
          <argument>
-           <name>Random</name>
+           <name>Shuffle</name>
            <direction>in</direction>
-           <relatedStateVariable>A_ARG_TYPE_boolean</relatedStateVariable>
+           <relatedStateVariable>Shuffle</relatedStateVariable>
          </argument>
        </argumentList>
      </action>
      <action>
-       <name>SeekSecondsAbsolute</name>
+       <name>SeekSecondAbsolute</name>
        <argumentList>
          <argument>
@@ Line 249: / Line 244: @@
          </argument>
          <argument>
-           <name>SecondsAbsolute</name>
+           <name>SecondAbsolute</name>
            <direction>in</direction>
            <relatedStateVariable>A_ARG_TYPE_uint</relatedStateVariable>
@@ Line 256: / Line 251: @@
      </action>
      <action>
-       <name>SeekSecondsRelative</name>
+       <name>SeekSecondRelative</name>
        <argumentList>
          <argument>
@@ Line 264: / Line 259: @@
          </argument>
          <argument>
-           <name>SecondsRelative</name>
+           <name>SecondRelative</name>
            <direction>in</direction>
            <relatedStateVariable>A_ARG_TYPE_int</relatedStateVariable>
@@ Line 294: / Line 289: @@
        <argumentList>
          <argument>
-           <name>NextAvailable</name>
+           <name>CanSkipNext</name>
            <direction>out</direction>
-           <relatedStateVariable>NextAvailable</relatedStateVariable>
+           <relatedStateVariable>CanSkipNext</relatedStateVariable>
          </argument>
          <argument>
-           <name>PrevAvailable</name>
+           <name>CanSkipPrevious</name>
            <direction>out</direction>
-           <relatedStateVariable>PrevAvailable</relatedStateVariable>
+           <relatedStateVariable>CanSkipPrevious</relatedStateVariable>
          </argument>
          <argument>
-           <name>RepeatAvailable</name>
+           <name>CanRepeat</name>
            <direction>out</direction>
-           <relatedStateVariable>RepeatAvailable</relatedStateVariable>
+           <relatedStateVariable>CanRepeat</relatedStateVariable>
          </argument>
          <argument>
-           <name>RandomAvailable</name>
+           <name>CanShuffle</name>
            <direction>out</direction>
-           <relatedStateVariable>RandomAvailable</relatedStateVariable>
+           <relatedStateVariable>CanShuffle</relatedStateVariable>
          </argument>
        </argumentList>
@@ Line 324: / Line 319: @@
          </argument>
          <argument>
-           <name>Seekable</name>
+           <name>CanSeek</name>
            <direction>out</direction>
-           <relatedStateVariable>Seekable</relatedStateVariable>
+           <relatedStateVariable>CanSeek</relatedStateVariable>
          </argument>
          <argument>
-           <name>Pausable</name>
+           <name>CanPause</name>
            <direction>out</direction>
-           <relatedStateVariable>Pausable</relatedStateVariable>
+           <relatedStateVariable>CanPause</relatedStateVariable>
          </argument>
        </argumentList>
@@ Line 356: / Line 351: @@
      </action>
      <action>
-       <name>Random</name>
+       <name>Shuffle</name>
        <argumentList>
          <argument>
-           <name>Random</name>
+           <name>Shuffle</name>
            <direction>out</direction>
-           <relatedStateVariable>Random</relatedStateVariable>
+           <relatedStateVariable>Shuffle</relatedStateVariable>
          </argument>
        </argumentList>
@@ Line 372: / Line 367: @@
      </stateVariable>
      <stateVariable sendEvents="yes">
-       <name>NextAvailable</name>
+       <name>CanSkipNext</name>
        <dataType>boolean</dataType>
      </stateVariable>
      <stateVariable sendEvents="yes">
-       <name>PrevAvailable</name>
+       <name>CanSkipPrevious</name>
        <dataType>boolean</dataType>
      </stateVariable>
      <stateVariable sendEvents="yes">
-       <name>RepeatAvailable</name>
+       <name>CanRepeat</name>
        <dataType>boolean</dataType>
      </stateVariable>
      <stateVariable sendEvents="yes">
-       <name>RandomAvailable</name>
+       <name>CanShuffle</name>
        <dataType>boolean</dataType>
      </stateVariable>
@@ Line 392: / Line 387: @@
      </stateVariable>
      <stateVariable sendEvents="yes">
-       <name>Seekable</name>
+       <name>CanSeek</name>
        <dataType>boolean</dataType>
      </stateVariable>
      <stateVariable sendEvents="yes">
-       <name>Pausable</name>
+       <name>CanPause</name>
        <dataType>boolean</dataType>
      </stateVariable>
@@ Line 415: / Line 410: @@
      </stateVariable>
      <stateVariable sendEvents="yes">
-       <name>Random</name>
+       <name>Shuffle</name>
        <dataType>boolean</dataType>
      </stateVariable>
@@ Line 429: / Line 424: @@
        <name>A_ARG_TYPE_string</name>
        <dataType>string</dataType>
-    </stateVariable>
-    <stateVariable sendEvents="no">
-      <name>A_ARG_TYPE_boolean</name>
-      <dataType>boolean</dataType>
      </stateVariable>
    </serviceStateTable>
 </scpd>
 </syntaxhighlight>

From OpenHome

Revision as of 15:06, 1 May 2017

Contents

Transport Service

Overview

Evented Properties

Modes

CanSkipNext

CanSkipPrevious

CanRepeat

CanShuffle

StreamId

CanSeek

CanPause

TransportState

Repeat

Shuffle

Actions

PlayAs

Play

Pause

Stop

Next

Previous

SetRepeat

SetShuffle

SeekSecondAbsolute

SeekSecondRelative

TransportState

Modes

ModeInfo

StreamInfo

StreamId

Repeat

Shuffle

UPnP Service Description