Variable UrlPlaybackComponentConst

Type declaration

• Readonlyattributes: {
      acceptHeader: Attribute<string[], any>;
      supportedStreamingProtocols: Attribute<TypeFromPartialBitSchema<{
          dash: BitFlag;
          hls: BitFlag;
      }>, any>;
  }

  • ReadonlyacceptHeader: Attribute<string[], any>

    This attribute shall provide a list of content types supported by the Video Player or Content App in the form of entries in the HTTP "Accept" request header.

    See

    MatterSpecification.v13.Cluster § 6.7.6.1

  • ReadonlysupportedStreamingProtocols: Attribute<TypeFromPartialBitSchema<{
        dash: BitFlag;
        hls: BitFlag;
    }>, any>

    This attribute shall provide information about supported streaming protocols.

    See

    MatterSpecification.v13.Cluster § 6.7.6.2

• Readonlycommands: {
      launchUrl: Command<TypeFromFields<{
          brandingInformation: OptionalFieldType<TypeFromFields<{
              background: OptionalFieldType<TypeFromFields<{
                  color: ...;
                  imageUrl: ...;
                  size: ...;
              }>>;
              logo: OptionalFieldType<TypeFromFields<{
                  color: ...;
                  imageUrl: ...;
                  size: ...;
              }>>;
              progressBar: OptionalFieldType<TypeFromFields<{
                  color: ...;
                  imageUrl: ...;
                  size: ...;
              }>>;
              providerName: FieldType<string>;
              splash: OptionalFieldType<TypeFromFields<{
                  color: ...;
                  imageUrl: ...;
                  size: ...;
              }>>;
              waterMark: OptionalFieldType<TypeFromFields<{
                  color: ...;
                  imageUrl: ...;
                  size: ...;
              }>>;
          }>>;
          contentUrl: FieldType<string>;
          displayString: OptionalFieldType<string>;
          playbackPreferences: OptionalFieldType<TypeFromFields<{
              audioTracks: OptionalFieldType<null | (...)[]>;
              playbackPosition: OptionalFieldType<null | number | bigint>;
              textTrack: OptionalFieldType<null | TypeFromFields<(...)>>;
          }>>;
      }>, TypeFromFields<{
          data: OptionalFieldType<string>;
          status: FieldType<ContentLauncher.Status>;
      }>, any>;
  }

  • ReadonlylaunchUrl: Command<TypeFromFields<{
        brandingInformation: OptionalFieldType<TypeFromFields<{
            background: OptionalFieldType<TypeFromFields<{
                color: ...;
                imageUrl: ...;
                size: ...;
            }>>;
            logo: OptionalFieldType<TypeFromFields<{
                color: ...;
                imageUrl: ...;
                size: ...;
            }>>;
            progressBar: OptionalFieldType<TypeFromFields<{
                color: ...;
                imageUrl: ...;
                size: ...;
            }>>;
            providerName: FieldType<string>;
            splash: OptionalFieldType<TypeFromFields<{
                color: ...;
                imageUrl: ...;
                size: ...;
            }>>;
            waterMark: OptionalFieldType<TypeFromFields<{
                color: ...;
                imageUrl: ...;
                size: ...;
            }>>;
        }>>;
        contentUrl: FieldType<string>;
        displayString: OptionalFieldType<string>;
        playbackPreferences: OptionalFieldType<TypeFromFields<{
            audioTracks: OptionalFieldType<null | (...)[]>;
            playbackPosition: OptionalFieldType<null | number | bigint>;
            textTrack: OptionalFieldType<null | TypeFromFields<(...)>>;
        }>>;
    }>, TypeFromFields<{
        data: OptionalFieldType<string>;
        status: FieldType<ContentLauncher.Status>;
    }>, any>

    Upon receipt, this shall launch content from the specified URL.

    The content types supported include those identified in the AcceptHeader and SupportedStreaming

    Protocols attributes.

    A check shall be made to ensure the URL is secure (uses HTTPS).

    When playing a video stream in response to this command, an indication (ex. visual) of the identity of the origin node of the video stream shall be provided. This could be in the form of a friendly name label which uniquely identifies the node to the user. This friendly name label is typically assigned by the Matter Admin (ex. TV) at the time of commissioning and, when it’s a device, is often editable by the user. It might be a combination of a company name and friendly name, for example, ”Acme” or “Acme Streaming Service on Alice’s Phone”.

    This command returns a Launch Response.

    See

    MatterSpecification.v13.Cluster § 6.7.7.2