Console

ExtendedMediaInputTrait 

struct ExtendedMediaInputTrait

This trait is an extension of the Matter standard trait, MediaInput, and is used by devices that can switch inputs.

  • 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: Google.ExtendedMediaInputTrait, rhs: Google.ExtendedMediaInputTrait) -> Bool

    Parameters

    lhs

    A value to compare.
    rhs

    Another value to compare.

  • Attributes for the ExtendedMediaInputTrait.

    Declaration

    Swift

    struct Attributes

  • Available-input definitions.

    Declaration

    Swift

    struct AvailableInput

  • Input names for a given available language.

    Declaration

    Swift

    struct InputNames

  • List of attributes for the ExtendedMediaInputTrait.

    Declaration

    Swift

    let attributes: Google.ExtendedMediaInputTrait.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.

  • Metadata about this Trait.

    Declaration

    Swift

    let metadata: TraitMetadata

  • Select the next input. Applicable only when the customInputsOrdered attribute is set to true.

    Declaration

    Swift

    func nextInput() async throws

  • The batchable version of nextInput command above.

    See also

    nextInput

    Declaration

    Swift

    func nextInputBatchable() throws -> BatchableCommand<Void>

  • Select the previous input. Applicable only when the customInputsOrdered attribute is set to true.

    Declaration

    Swift

    func previousInput() async throws

  • The batchable version of previousInput command above.

    See also

    previousInput

    Declaration

    Swift

    func previousInputBatchable() throws -> BatchableCommand<Void>

  • Set the media input.

    Declaration

    Swift

    func selectCustomInput(newInput: String) async throws

    Parameters

    newInput

    Key of the new input.

  • The batchable version of selectCustomInput command above.

    See also

    selectCustomInput

    Declaration

    Swift

    func selectCustomInputBatchable(newInput: String) throws -> BatchableCommand<Void>

  • List of the commands that are supported by ExtendedMediaInputTrait.

    Declaration

    Swift

    static let supportedCommandTypes: [any Command.Type]

  • No supported events for ExtendedMediaInputTrait.

    Declaration

    Swift

    static let supportedEventTypes: [any Event.Type]

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

    Declaration

    Swift

    var supportsNextInputCommand: Bool { get }

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

    Declaration

    Swift

    var supportsPreviousInputCommand: Bool { get }

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

    Declaration

    Swift

    var supportsSelectCustomInputCommand: Bool { get }