Console

MediaInputTrait 

struct MediaInputTrait

This trait provides an interface for controlling the input selector on a media device such as a video player.

  • No supported events for MediaInputTrait.

    Declaration

    Swift

    static let supportedEventTypes: [any Event.Type]

  • List of the commands that are supported by MediaInputTrait.

    Declaration

    Swift

    static let supportedCommandTypes: [any Command.Type]

  • The trait identifier.

    Declaration

    Swift

    static let identifier: String

  • Metadata about this Trait.

    Declaration

    Swift

    let metadata: TraitMetadata

  • List of attributes for the MediaInputTrait.

    Declaration

    Swift

    let attributes: Matter.MediaInputTrait.Attributes

  • 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.

  • 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

  • Attributes for the MediaInputTrait.

    Declaration

    Swift

    struct Attributes

  • 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.MediaInputTrait, rhs: Matter.MediaInputTrait) -> Bool

    Parameters

    lhs

    A value to compare.
    rhs

    Another value to compare.

  • 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)

  • Information about an input.

    Declaration

    Swift

    struct InputInfoStruct

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

    Declaration

    Swift

    var supportsSelectInputCommand: Bool { get }

  • Change the media input on the device.

    Declaration

    Swift

    func selectInput(index: UInt8) async throws

    Parameters

    index

    The index of the input to select.

  • The batchable version of selectInput command above.

    See also

    selectInput

    Declaration

    Swift

    func selectInputBatchable(index: UInt8) throws -> BatchableCommand<Void>

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

    Declaration

    Swift

    var supportsShowInputStatusCommand: Bool { get }

  • Show the input list on the display.

    Declaration

    Swift

    func showInputStatus() async throws

  • The batchable version of showInputStatus command above.

    See also

    showInputStatus

    Declaration

    Swift

    func showInputStatusBatchable() throws -> BatchableCommand<Void>

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

    Declaration

    Swift

    var supportsHideInputStatusCommand: Bool { get }

  • Hide the input list on the display.

    Declaration

    Swift

    func hideInputStatus() async throws

  • The batchable version of hideInputStatus command above.

    See also

    hideInputStatus

    Declaration

    Swift

    func hideInputStatusBatchable() throws -> BatchableCommand<Void>

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

    Declaration

    Swift

    var supportsRenameInputCommand: Bool { get }

  • Change the name of the specified input.

    Declaration

    Swift

    func renameInput(index: UInt8, name: String) async throws

    Parameters

    index

    The index of the input to be renamed.
    name

    The new name for the specified input.

  • The batchable version of renameInput command above.

    See also

    renameInput

    Declaration

    Swift

    func renameInputBatchable(index: UInt8, name: String) throws -> BatchableCommand<Void>

  • Types of input.

    Declaration

    Swift

    enum InputTypeEnum

  • The MediaInput cluster FeatureMap.

    Declaration

    Swift

    struct Feature