Console

ChannelTrait 

struct ChannelTrait

This trait provides an interface for selecting channels on a device or endpoint.

  • No supported events for ChannelTrait.

    Declaration

    Swift

    static let supportedEventTypes: [any Event.Type]

  • List of the commands that are supported by ChannelTrait.

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

    Declaration

    Swift

    let attributes: Matter.ChannelTrait.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 ChannelTrait.

    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.ChannelTrait, rhs: Matter.ChannelTrait) -> 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)

  • The cast information related to a program.

    Declaration

    Swift

    struct ProgramCastStruct

  • The category associated to a program.

    Declaration

    Swift

    struct ProgramCategoryStruct

  • The episode information related to a program.

    Declaration

    Swift

    struct SeriesInfoStruct

  • A channel in a channel lineup.

    Declaration

    Swift

    struct ChannelInfoStruct

  • A program within an electronic program guide (EPG).

    Declaration

    Swift

    struct ProgramStruct

  • The pagination structure.

    Declaration

    Swift

    struct PageTokenStruct

  • The paging structure that includes the previous and next pagination tokens.

    Declaration

    Swift

    struct ChannelPagingStruct

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

    Declaration

    Swift

    struct AdditionalInfoStruct

  • A channel lineup.

    Declaration

    Swift

    struct LineupInfoStruct

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

    Declaration

    Swift

    var supportsChangeChannelCommand: Bool { get }

  • Change the channel to the specified channel.

    Declaration

    Swift

    func changeChannel(match: String) async throws -> Matter.ChannelTrait.ChangeChannelCommandResponse

    Parameters

    match

    A string used to identify the intended channel, which may be a call sign, a name, or a number.

    Return Value

    The status of the ChangeChannel command.

  • The batchable version of changeChannel command above.

    See also

    changeChannel

    Declaration

    Swift

    func changeChannelBatchable(match: String) throws -> BatchableCommand<Matter.ChannelTrait.ChangeChannelCommandResponse>

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

    Declaration

    Swift

    var supportsChangeChannelByNumberCommand: Bool { get }

  • Change the channel to the channel specified by majorNumber and minorNumber.

    Declaration

    Swift

    func changeChannelByNumber(majorNumber: UInt16, minorNumber: UInt16) async throws

    Parameters

    majorNumber

    The channel major number value to which the channel should change, in ATSC format.
    minorNumber

    The channel minor number value to which the channel should change, in ATSC format.

  • The batchable version of changeChannelByNumber command above.

    See also

    changeChannelByNumber

    Declaration

    Swift

    func changeChannelByNumberBatchable(majorNumber: UInt16, minorNumber: UInt16) throws -> BatchableCommand<Void>

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

    Declaration

    Swift

    var supportsSkipChannelCommand: Bool { get }

  • Provides channel up and channel down functionality, by allowing the index of the selected channel to jump by the specified number of steps.

    Declaration

    Swift

    func skipChannel(count: Int16) async throws

    Parameters

    count

    When positive, count specifies the number of steps to increase the current channel number. When negative, it specifies the number of steps to decrease the current channel number.

  • The batchable version of skipChannel command above.

    See also

    skipChannel

    Declaration

    Swift

    func skipChannelBatchable(count: Int16) throws -> BatchableCommand<Void>

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

    Declaration

    Swift

    var supportsGetProgramGuideCommand: Bool { get }

  • Retrieves the program guide.

    Declaration

    Swift

    func getProgramGuide(optionalArgsProvider: ((Matter.ChannelTrait.GetProgramGuideCommand.OptionalArgs) -> Void)? = nil) async throws -> Matter.ChannelTrait.GetProgramGuideCommandResponse

    Return Value

    The program guide response.

  • The batchable version of getProgramGuide command above.

    See also

    getProgramGuide

    Declaration

    Swift

    func getProgramGuideBatchable(optionalArgsProvider: ((Matter.ChannelTrait.GetProgramGuideCommand.OptionalArgs) -> Void)? = nil) throws -> BatchableCommand<Matter.ChannelTrait.GetProgramGuideCommandResponse>

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

    Declaration

    Swift

    var supportsRecordProgramCommand: Bool { get }

  • Record a specific program or series when it goes live.

    Declaration

    Swift

    func recordProgram(programIdentifier: String, shouldRecordSeries: Bool, externalIDList: [Matter.ChannelTrait.AdditionalInfoStruct], data: Data) async throws

    Parameters

    programIdentifier

    The program identifier for the program that should be recorded.
    shouldRecordSeries

    Whether the whole series associated to the program should be recorded.
    data

    Optional app-specific data.

  • The batchable version of recordProgram command above.

    See also

    recordProgram

    Declaration

    Swift

    func recordProgramBatchable(programIdentifier: String, shouldRecordSeries: Bool, externalIDList: [Matter.ChannelTrait.AdditionalInfoStruct], data: Data) throws -> BatchableCommand<Void>

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

    Declaration

    Swift

    var supportsCancelRecordProgramCommand: Bool { get }

  • Cancel recording for a specific program or series.

    Declaration

    Swift

    func cancelRecordProgram(programIdentifier: String, shouldRecordSeries: Bool, externalIDList: [Matter.ChannelTrait.AdditionalInfoStruct], data: Data) async throws

    Parameters

    programIdentifier

    The program identifier for the program that should be cancelled from recording.
    shouldRecordSeries

    Whether the whole series associated to the program should be cancelled from recording.
    data

    Optional app-specific data.

  • The batchable version of cancelRecordProgram command above.

    See also

    cancelRecordProgram

    Declaration

    Swift

    func cancelRecordProgramBatchable(programIdentifier: String, shouldRecordSeries: Bool, externalIDList: [Matter.ChannelTrait.AdditionalInfoStruct], data: Data) throws -> BatchableCommand<Void>

  • Types of channels.

    Declaration

    Swift

    enum ChannelTypeEnum

  • Types of lineup information.

    Declaration

    Swift

    enum LineupInfoTypeEnum

  • Statuses for channel selection commands.

    Declaration

    Swift

    enum StatusEnum

  • Channel cluster FeatureMap.

    Declaration

    Swift

    struct Feature

  • Recording flags.

    Declaration

    Swift

    struct RecordingFlagBitmap