Console

WebRtcLiveViewTrait 

struct WebRtcLiveViewTrait

This trait provides the functionality to control a live view session.

  • No supported events for WebRtcLiveViewTrait.

    Declaration

    Swift

    static let supportedEventTypes: [any Event.Type]

  • List of the commands that are supported by WebRtcLiveViewTrait.

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

    Declaration

    Swift

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

    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: Google.WebRtcLiveViewTrait, rhs: Google.WebRtcLiveViewTrait) -> 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)

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

    Declaration

    Swift

    var supportsStartLiveViewCommand: Bool { get }

  • Start a WebRTC live stream.

    Declaration

    Swift

    func startLiveView(offerSdp: String) async throws -> Google.WebRtcLiveViewTrait.StartLiveViewCommandResponse

    Parameters

    offerSdp

    An SDP offer, specific to the local device that will display the WebRTC live stream.

    Return Value

    The outcome of the ExtendLiveView command.

  • The batchable version of startLiveView command above.

    See also

    startLiveView

    Declaration

    Swift

    func startLiveViewBatchable(offerSdp: String) throws -> BatchableCommand<Google.WebRtcLiveViewTrait.StartLiveViewCommandResponse>

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

    Declaration

    Swift

    var supportsStopLiveViewCommand: Bool { get }

  • Stop a WebRTC live stream.

    Declaration

    Swift

    func stopLiveView(mediaSessionId: String) async throws

    Parameters

    mediaSessionId

    The media session ID of the live stream to start.

  • The batchable version of stopLiveView command above.

    See also

    stopLiveView

    Declaration

    Swift

    func stopLiveViewBatchable(mediaSessionId: String) throws -> BatchableCommand<Void>

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

    Declaration

    Swift

    var supportsStartTalkbackCommand: Bool { get }

  • Start a WebRTC live stream.

    Declaration

    Swift

    func startTalkback(mediaSessionId: String, optionalArgsProvider: ((Google.WebRtcLiveViewTrait.StartTalkbackCommand.OptionalArgs) -> Void)? = nil) async throws

    Parameters

    mediaSessionId

    The media session ID of the live stream to start.

  • The batchable version of startTalkback command above.

    See also

    startTalkback

    Declaration

    Swift

    func startTalkbackBatchable(mediaSessionId: String, optionalArgsProvider: ((Google.WebRtcLiveViewTrait.StartTalkbackCommand.OptionalArgs) -> Void)? = nil) throws -> BatchableCommand<Void>

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

    Declaration

    Swift

    var supportsStopTalkbackCommand: Bool { get }

  • Start a WebRTC live stream.

    Declaration

    Swift

    func stopTalkback(mediaSessionId: String) async throws

    Parameters

    mediaSessionId

    The media session ID of the live stream to stop.

  • The batchable version of stopTalkback command above.

    See also

    stopTalkback

    Declaration

    Swift

    func stopTalkbackBatchable(mediaSessionId: String) throws -> BatchableCommand<Void>

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

    Declaration

    Swift

    var supportsExtendLiveViewCommand: Bool { get }

  • Extend a WebRTC live stream.

    Declaration

    Swift

    func extendLiveView(mediaSessionId: String, optionalArgsProvider: ((Google.WebRtcLiveViewTrait.ExtendLiveViewCommand.OptionalArgs) -> Void)? = nil) async throws -> Google.WebRtcLiveViewTrait.ExtendLiveViewCommandResponse

    Parameters

    mediaSessionId

    The media session ID of the live stream to extend.

    Return Value

    The outcome of the ExtendLiveView command.

  • The batchable version of extendLiveView command above.

    See also

    extendLiveView

    Declaration

    Swift

    func extendLiveViewBatchable(mediaSessionId: String, optionalArgsProvider: ((Google.WebRtcLiveViewTrait.ExtendLiveViewCommand.OptionalArgs) -> Void)? = nil) throws -> BatchableCommand<Google.WebRtcLiveViewTrait.ExtendLiveViewCommandResponse>

  • The type of talkback supported by the device.

    Declaration

    Swift

    enum TalkbackType