Skip to content

Commit

Permalink
doc: add documentation about content protection to get{Audio,Video}Re…
Browse files Browse the repository at this point in the history
…presentation
  • Loading branch information
peaBerberian committed Oct 8, 2024
1 parent 4956854 commit 774fc1e
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 0 deletions.
11 changes: 11 additions & 0 deletions doc/api/Representation_Selection/getAudioRepresentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,17 @@ method will return an object with the following properties:
- `codec` (`string|undefined`): The audio codec the Representation is in, as announced in
the corresponding Manifest.

- `contentProtections` (`Object|undefined`): Encryption information linked to this
Representation.

If set to an Object, the Representation is known to be encrypted. If unset or set to
`undefined` the Representation is either unencrypted or we don't know if it is.

When set to an object, it may contain the following properties:

- `keyIds` (`Array.<Uint8Array>|undefined`): Known key ids linked to that
Representation.

You can also get the information on the loaded audio Representation for another Period by
calling `getAudioRepresentation` with the corresponding Period's id in argument. Such id
can be obtained through the `getAvailablePeriods` method, the `newAvailablePeriods` event
Expand Down
11 changes: 11 additions & 0 deletions doc/api/Representation_Selection/getVideoRepresentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,17 @@ method will return an object with the following properties:
- `hdrInfo` (`Object|undefined`) Information about the hdr characteristics of the
Representation. (see [HDR support documentation](../Miscellaneous/hdr.md#hdrinfo))

- `contentProtections` (`Object|undefined`): Encryption information linked to this
Representation.

If set to an Object, the Representation is known to be encrypted. If unset or set to
`undefined` the Representation is either unencrypted or we don't know if it is.

When set to an object, it may contain the following properties:

- `keyIds` (`Array.<Uint8Array>|undefined`): Known key ids linked to that
Representation.

You can also get the information on the loaded video Representation for another Period by
calling `getVideoRepresentation` with the corresponding Period's id in argument. Such id
can be obtained through the `getAvailablePeriods` method, the `newAvailablePeriods` event
Expand Down

0 comments on commit 774fc1e

Please sign in to comment.