bosesoundtouchapi.models.mediaitemcontainer

@export
class MediaItemContainer:

SoundTouch device MediaItemContainer configuration object.

This class contains the attributes and sub-items that represent a single MediaItemContainer configuration of the device.

MediaItemContainer(root: xml.etree.ElementTree.Element = None)

Initializes a new instance of the class.

Arguments:
  • root (Element): xmltree Element item to load arguments from.
    If specified, then other passed arguments are ignored.
ContentItem: bosesoundtouchapi.models.contentitem.ContentItem

ContentItem value.

ContainerArt: str

Content item's container art url.

IsPresetable: str

Returns True if the content item can be saved as a Preset; otherwise, False.

Location: str

If present, the content item's direct link to the media.

Name: str

Content item's name.

Offset: int

Offset of the item.

Source: str

Content item source type.

This value is defined at bosesoundtouchapi.soundtouchsources.SoundTouchSources.

SourceAccount: str

The account associated with the Source.

TypeValue: str

Specifies the type of the content item.

def ToDictionary(self, encoding: str = 'utf-8') -> dict:

Returns a dictionary representation of the class.

Arguments:
  • encoding (str): encode type (e.g. 'utf-8', 'unicode', etc).
    Default is 'utf-8'.
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.

def ToXmlString(self, encoding: str = 'utf-8') -> str:

Returns an xml string representation of the class.

Arguments:
  • encoding (str): encode type (e.g. 'utf-8', 'unicode', etc).
    Default is 'utf-8'.