bosesoundtouchapi.models.usertrackcontrol

@export
class UserTrackControl(bosesoundtouchapi.soundtouchmodelrequest.SoundTouchModelRequest):

SoundTouch device UserTrackControl configuration object.

This class contains the attributes and sub-items that represent the UserTrackControl configuration of the device.

UserTrackControl( trackControl: bosesoundtouchapi.models.usertrackcontroltypes.UserTrackControlTypes = None, startSecond: int = None, root: xml.etree.ElementTree.Element = None)

Initializes a new instance of the class.

Arguments:
  • trackControl (str): User track control value to set.
  • startSecond (int): Starting position (in seconds) of where to start playing the media content. This argument is only valid for UserTrackControlTypes.SEEK_TO_TIME requests.
  • root (Element): xmltree Element item to load arguments from.
    If specified, then other passed arguments are ignored.
TrackControl: str

User track control value (e.g. "NEXT_TRACK", "SEEK_TO_TIME", etc).

StartSecond: int

Starting position (in seconds) of where to start playing the media content.

def ToElement(self, isRequestBody: bool = False) -> xml.etree.ElementTree.Element:

Overridden.
Returns an xmltree Element node representation of the class.

Arguments:
  • isRequestBody (bool): True if the element should only return attributes needed for a POST request body; otherwise, False to return all attributes.
def ToString(self) -> str:

Returns a displayable string representation of the class.