DataTrackFrameFormat

data class DataTrackFrameFormat(val frameEncoding: DataTrackFrameEncoding, val schema: DataTrackSchemaId? = null)

Describes the frames on a data track.

A schema always describes frames in a specific encoding, so frameEncoding is required alongside a schema. The declared metadata is surfaced to subscribers via DataTrackInfo.

Whether a schema's encoding can actually describe frames in frameEncoding is checked when the track is published, surfacing as DataTrackPublishException.InvalidSchema.

Parameters

frameEncoding

Encoding of the track's frames.

schema

Schema describing the track's frames.

Constructors

Link copied to clipboard
constructor(frameEncoding: DataTrackFrameEncoding, schema: DataTrackSchemaId? = null)

Properties

Link copied to clipboard
Link copied to clipboard