Console

ContentLauncherTrait 

struct ContentLauncherTrait

This trait provides an interface for launching content on a video player device such as a streaming media player, smart TV, or smart screen.

  • Returns a Boolean value indicating whether two values are equal.

    Equality is the inverse of inequality. For any values a and b, a == b implies that a != b is false.

    Declaration

    Swift

    static func == (lhs: Matter.ContentLauncherTrait, rhs: Matter.ContentLauncherTrait) -> Bool

    Parameters

    lhs

    A value to compare.
    rhs

    Another value to compare.

  • Additional name-value pairs that can be used to identify content.

    Declaration

    Swift

    struct AdditionalInfoStruct

  • Attributes for the ContentLauncherTrait.

    Declaration

    Swift

    struct Attributes

  • Branding information that customizes the video player skin.

    Declaration

    Swift

    struct BrandingInformationStruct

  • Inputs to a search for content for display or playback.

    Declaration

    Swift

    struct ContentSearchStruct

  • A set of dimensions for a background image.

    Declaration

    Swift

    struct DimensionStruct

  • ContentLauncher cluster FeatureMap.

    Declaration

    Swift

    struct Feature

  • Indicates how a set of dimensions are defined.

    Declaration

    Swift

    enum MetricTypeEnum

  • Content data elements that may be searched on.

    Declaration

    Swift

    enum ParameterEnum

  • Inputs to a search for content for display or playback.

    Declaration

    Swift

    struct ParameterStruct

  • Launch statuses.

    Declaration

    Swift

    enum StatusEnum

  • Style information which can be used to change the media player’s visual style.

    Declaration

    Swift

    struct StyleInformationStruct

  • Supported streaming protocols.

    Declaration

    Swift

    struct SupportedProtocolsBitmap

  • List of attributes for the ContentLauncherTrait.

    Declaration

    Swift

    let attributes: Matter.ContentLauncherTrait.Attributes

  • Writes this object to the given TraitEncoder. Throws HomeError.encodingFailed if the data could not be encoded.

    Declaration

    Swift

    func encode(with encoder: TraitEncoder) throws

  • This API provides the ability to invalidate state retrieved through subscriptions to the target device in the cases where state is not being reported correctly, either intentionally (e.g attributes in Matter traits with the “C” quality) or unintentionally due to poor implementations.

    When successful, this API will result in a forced read of the convening scope as specified by the sub-class and return the result through existing Trait subscriptions if present and active.

    This API is to be used sparingly as it can impact the performance and battery life of the target device. As such, this API may be throttled by the platform. Callers SHALL be prepared to deal with HomeErrors thrown by this call.

    Declaration

    Swift

    func forceRead() async throws

  • Hashes the essential components of this value by feeding them into the given hasher.

    Implement this method to conform to the Hashable protocol. The components used for hashing must be the same as the components compared in your type’s == operator implementation. Call hasher.combine(_:) with each of these components.

    Important

    In your implementation of hash(into:), don’t call finalize() on the hasher instance provided, or replace it with a different instance. Doing so may become a compile-time error in the future.

    Declaration

    Swift

    func hash(into hasher: inout Hasher)

  • The trait identifier.

    Declaration

    Swift

    static let identifier: String

  • Creates a new Trait instance using data read from the given TraitDecoder.

    Throws

    HomeError.parseError when parsing fails.

    Declaration

    Swift

    init(decoder: TraitDecoder, interactionProxy: (any InteractionProxy)?, metadata: TraitMetadata) throws

    Parameters

    decoder

    The raw data representing this Trait.
    interactionProxy

    Proxy to the Interaction Client.
    metadata

    Metadata about this Trait.

  • Launch the specified content.

    Declaration

    Swift

    func launchContent(search: Matter.ContentLauncherTrait.ContentSearchStruct, autoPlay: Bool, optionalArgsProvider: ((Matter.ContentLauncherTrait.LaunchContentCommand.OptionalArgs) -> Void)? = nil) async throws -> Matter.ContentLauncherTrait.LaunchContentCommandResponse

    Parameters

    search

    The content to launch.
    autoPlay

    Set to true to have the matching content play automatically.

    Return Value

    The outcome of the LaunchContent command.

  • The batchable version of launchContent command above.

    See also

    launchContent

    Declaration

    Swift

    func launchContentBatchable(search: Matter.ContentLauncherTrait.ContentSearchStruct, autoPlay: Bool, optionalArgsProvider: ((Matter.ContentLauncherTrait.LaunchContentCommand.OptionalArgs) -> Void)? = nil) throws -> BatchableCommand<Matter.ContentLauncherTrait.LaunchContentCommandResponse>

  • Launch content from the specified URL.

    Declaration

    Swift

    func launchUrl(contentUrl: String, optionalArgsProvider: ((Matter.ContentLauncherTrait.LaunchUrlCommand.OptionalArgs) -> Void)? = nil) async throws -> Matter.ContentLauncherTrait.LaunchUrlCommandResponse

    Parameters

    contentUrl

    The URL of the content to launch.

    Return Value

    The outcome of the LaunchUrl command.

  • The batchable version of launchUrl command above.

    See also

    launchUrl

    Declaration

    Swift

    func launchUrlBatchable(contentUrl: String, optionalArgsProvider: ((Matter.ContentLauncherTrait.LaunchUrlCommand.OptionalArgs) -> Void)? = nil) throws -> BatchableCommand<Matter.ContentLauncherTrait.LaunchUrlCommandResponse>

  • Metadata about this Trait.

    Declaration

    Swift

    let metadata: TraitMetadata

  • List of the commands that are supported by ContentLauncherTrait.

    Declaration

    Swift

    static let supportedCommandTypes: [any Command.Type]

  • No supported events for ContentLauncherTrait.

    Declaration

    Swift

    static let supportedEventTypes: [any Event.Type]

  • Whether the device supports the launchContent command for this trait.

    Declaration

    Swift

    var supportsLaunchContentCommand: Bool { get }

  • Whether the device supports the launchUrl command for this trait.

    Declaration

    Swift

    var supportsLaunchUrlCommand: Bool { get }