bosesoundtouchapi.models.nowplayingstatus

Initializes a new instance of the class.

Arguments:

• source (SoundTouchSources|str): Source input.
• sourceAccount (str): Source account this content item is played with.
• album (str): The album of the playing track (if present).
• artist (str): The creator of the track (if present).
• artistId (str): Unique identifier of the artist, as provided by the source music service (if present).
• artUrl (str): A url link to the art image of the station (if present).
• description (str): A brief description that was added to the track (if present).
• duration (int): The track's duration (if present).
• genre (str): The genre of the track (if present).
• playStatus (str): Indicates whether the device is currently playing the embedded track.
• position (int): The current position of the playing media (if present).
• sessionId (str): Unique identifier of the session, as provided by the source music service (if present).
• stationLocation (str): The station's location.
• stationName (str): The station's name (if present).
• track (str): The current media track name (if present).
• trackId (str): Unique identifier of the track, as provided by the source music service (if present).
• root (Element): xmltree Element item to load arguments from.
  If specified, then other passed arguments are ignored.

The album of the playing track (if present).

Contains "IMAGE_PRESENT" value if an art image url is present.

A url link to the art image of the station (if present).

Note that this art image could be different from the ContentItem.ContainerArt image.

The creator of the track (if present).

Unique identifier of the artist, as provided by the source music service (if present).

The staus of the bluetooth connection (if present).

This value only seems to be present for the "BLUETOOTH" source.

The staus of the bluetooth connection (if present).

This value only seems to be present for the "BLUETOOTH" source.

A url link to the art image of the station or track that is playing. The following logic is implemented to return an image url:

• the ArtUrl value is returned if present;
• the ContentItem.ContainerArt url is returned if present;
• if neither of the above, then null is returned.

This is a helper property, and not part of the SoundTouch Web Services specification.

The selected ContentItem.

A brief description that was added to the track (if present).

Device identifier the configuration information was obtained from.

The track's duration (if present).

The genre of the track (if present).

True if the currently playing track is an advertisement; otherwise, False.

Note that not all sources track advertisements.

• TuneIn source does not track advertisements;
• Pandora music service source tracks advertisements.

True if the track has been marked as a favorite; otherwise, False.

Note that not all sources track favorites.

True if the track can be saved as a favorite; otherwise, False.

Returns true if the current PlayStatus is "PLAY_STATE", which indicates the content is fully playing (e.g. not buffered, etc); otherwise, False.

True if track rating is enabled; otherwise, False.

If true, then the SoundTouchClient.ThumbsUp and

True if repeat play (one or all) is enabled; otherwise, False.

The RepeatSetting property contains the actual repeat setting.

True if the currently playing media supports seek functions; otherwise, False (if present).

True if shuffle play is enabled; otherwise, False.

True if the currently playing media supports skip functions; otherwise, False (if present).

True if the currently playing media skip previous functions are enabled; otherwise, False (if present).

True if the currently playing media supports skip previous functions; otherwise, False (if present).

Indicates the current play status of the item (e.g. "PLAY_STATE", "BUFFERING_STATE", etc.)

The current position of the playing media (if present).

Rating value (e.g. "NONE", "DOWN", "UP", etc).

Repeat setting value (e.g. "REPEAT_ALL", "REPEAT_ONE", "REPEAT_OFF", etc).

If null, then repeat functions are not enabled for the playing media.

Unique identifier of the session, as provided by the source music service (if present).

Shuffle setting value (e.g. "SHUFFLE_ON", "SHUFFLE_OFF", etc).

If null, then shuffle functions are not enabled for the playing media.

The media source. This should be one of the sources defined in bosesoundtouchapi.soundtouchsources.SoundTouchSources.

The account associated with the Source.

The station's location.

The station's name (if present).

The stream type of the current track (e.g. "RADIO_STREAMING", "TRACK_ONDEMAND" when playing from an external resource, etc).

The current media track name (if present).

Unique identifier of the track, as provided by the source music service (if present).

Returns a displayable string representation of the class.