Skip to content

Commit

Permalink
Update documentation and fix anchors
Browse files Browse the repository at this point in the history
  • Loading branch information
peaBerberian committed Feb 5, 2024
1 parent 85d7dbc commit 6c27c67
Show file tree
Hide file tree
Showing 14 changed files with 145 additions and 135 deletions.
4 changes: 2 additions & 2 deletions doc/.docConfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
"favicon": {
"srcPath": "./static/img/favicon.png"
},
"otherVersionsLink": "https://developers.canal-plus.com/rx-player/documentation_pages_by_version.html",
"linksLeft": [
{
"type": "local-doc",
Expand Down Expand Up @@ -43,7 +42,8 @@
"link": "https://github.com/canalplus/rx-player"
},
{
"type": "version"
"type": "version",
"link": "https://developers.canal-plus.com/rx-player/documentation_pages_by_version.html"
}
]
}
4 changes: 2 additions & 2 deletions doc/Getting_Started/Glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,12 +58,12 @@ Example of such types are:
### Chunk

Depending on the context, a chunk can be either a sub-part of a [Media
Segment](#media_segment) or the Media segment itself.
Segment](#media-segment) or the Media segment itself.

### Initialization segment

An initialization segment is a specific type of [media
segment](#media_segment), which includes metadata necessary to initialize the
segment](#media-segment), which includes metadata necessary to initialize the
browser's internal decoder.

Those are sometimes needed before we can actually begin to push any "real" media
Expand Down
4 changes: 2 additions & 2 deletions doc/Getting_Started/Migration_From_v3/Bitrate_Selection.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,8 +190,8 @@ by using:

- The [`videoTrackChange`](../../api/Player_Events.md#videotrackchange),
[`audioTrackChange`](../../api/Player_Events.md#audiotrackchange),
[`availableVideoTracksChange`](../../api/Player_Events.md#availablevideotracks) and
[`availableAudioTracksChange`](../../api/Player_Events.md#availableaudiotracks)
[`availableVideoTracksChange`](../../api/Player_Events.md#availablevideotrackschange) and
[`availableAudioTracksChange`](../../api/Player_Events.md#availableaudiotrackschange)
player events which respectively emit data similar to the `getVideoTrack`,
`getAudioTrack`, `getAvailableVideoTracks` and `getAvailableAudioTracks`
methods.
Expand Down
2 changes: 1 addition & 1 deletion doc/Getting_Started/Migration_From_v3/Overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ bugs.

This means that you now have to make sure that state is considered. You can see
more information on the `"RELOADING"` state [in the player state
page](../../api/Player_States.md#the_reloading_state).
page](../../api/Player_States.md#the-reloading-state).
Thankfully, it is now possible to perform more operations under that state, such
as switching tracks and qualities.

Expand Down
4 changes: 2 additions & 2 deletions doc/Getting_Started/Migration_From_v3/loadVideo_Options.md
Original file line number Diff line number Diff line change
Expand Up @@ -330,8 +330,8 @@ the `keySystems` `loadVideo` options allowed to configure the wanted robustnes
levels of encrypted content.

They have now been replaced by the much more powerful
[`audioCapabilitiesConfig`](../../api/Decryption_Options.md#audiocapabilitiesconfig)
and [`videoCapabilitiesConfig`](../../api/Decryption_Options.md#videocapabilitiesconfig)
[`audioCapabilitiesConfig`](../../api/Decryption_Options.md#videocapabilitiesconfig--audiocapabilitiesconfig)
and [`videoCapabilitiesConfig`](../../api/Decryption_Options.md#videocapabilitiesconfig--audiocapabilitiesconfig)
respectively.

What was previously written:
Expand Down
14 changes: 7 additions & 7 deletions doc/api/Decryption_Options.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ If this callback throws or rejects, the RxPlayer will either:

If we have no Representation to fallback to anymore, we will throw a
MediaError with a `NO_PLAYABLE_REPRESENTATION` code, as documented [in
the errors documentation](./Player_Errors.md#types-media_error).
the errors documentation](./Player_Errors.md#media_error).

If the `getLicense` call throws/rejects, you can add any of the following
properties (none are mandatory) to configure the behavior of the RxPlayer
Expand Down Expand Up @@ -163,7 +163,7 @@ relative to that failure:
Representations (e.g. qualities) which might have a different decryption
key. If no Representation is left, we will throw a MediaError with a
`NO_PLAYABLE_REPRESENTATION` code, as documented [in the errors
documentation](./Player_Errors.md#types-media_error).
documentation](./Player_Errors.md#media_error).

This option is thus only useful for contents depending on multiple
licenses.
Expand Down Expand Up @@ -399,7 +399,7 @@ or
will be required, optional or not-allowed.

It can be set to any value of the `MediaKeysRequirement` enumeration, as
declared [here in the EME specification](#https://www.w3.org/TR/encrypted-media/#dom-mediakeysrequirement).
declared [here in the EME specification](https://www.w3.org/TR/encrypted-media/#dom-mediakeysrequirement).
This is not needed for most use cases.


Expand All @@ -421,7 +421,7 @@ exploiting persistent licenses already necessitate the ability to persist
session state).

It can be set to any value of the `MediaKeysRequirement` enumeration, as
declared [here in the EME specification](#https://www.w3.org/TR/encrypted-media/#dom-mediakeysrequirement).
declared [here in the EME specification](https://www.w3.org/TR/encrypted-media/#dom-mediakeysrequirement).
This is not needed for most use cases.


Expand All @@ -444,7 +444,7 @@ behavior, the default one if not is defined being `"error"`:
This is the default behavior.

The error emitted in that case should be an
[EncryptedMediaError](./Player_Errors.md#encryptedmediaerror) with a
[EncryptedMediaError](./Player_Errors.md#encrypted_media_error) with a
`KEY_STATUS_CHANGE_ERROR` `code` property with a set `keyStatuses`
property containing at least one string set to `"output-restricted"`.

Expand Down Expand Up @@ -482,7 +482,7 @@ behavior, the default one if not is defined being `"error"`:
This is the default behavior.

The error emitted in that case should be an
[EncryptedMediaError](./Player_Errors.md#encryptedmediaerror) with a
[EncryptedMediaError](./Player_Errors.md#encrypted_media_error) with a
`KEY_STATUS_CHANGE_ERROR` `code` property with a set `keyStatuses`
property containing at least one string set to `"internal-error"`.

Expand Down Expand Up @@ -528,7 +528,7 @@ the default one if not is defined being `"error"`:
This is the default behavior.

The error emitted in that case should be an
[EncryptedMediaError](./Player_Errors.md#encryptedmediaerror) with a
[EncryptedMediaError](./Player_Errors.md#encrypted_media_error) with a
`KEY_STATUS_CHANGE_ERROR` `code` property with a set `keyStatuses`
property containing at least one string set to `"expired"`.

Expand Down
2 changes: 1 addition & 1 deletion doc/api/Loading_a_Content.md
Original file line number Diff line number Diff line change
Expand Up @@ -960,7 +960,7 @@ Note that there is a risk of us losing synchronization when leap seconds are
added/substracted to unix time. However we consider those situations rare enough
(and the effect should be relatively weak) to let this as is for the moment. For
a complete explanation, you can look at the [corresponding chapter of the
low-latency documentation](./Miscellaneous/Low_Latency.md#note-time-sync).
low-latency documentation](./Miscellaneous/Low_Latency.md#note-about-time-synchronization).


### referenceDateTime
Expand Down
2 changes: 1 addition & 1 deletion doc/api/Miscellaneous/Local_Contents.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ rxPlayer.loadVideo({
```

More infos on the `manifestLoader` can be found
[here](./plugins.md#manifestLoader).
[here](./plugins.md#manifestloader).

## How to import this feature

Expand Down
2 changes: 1 addition & 1 deletion doc/api/Miscellaneous/Local_Manifest_v0.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ rxPlayer.loadVideo({
```

More infos on the `manifestLoader` can be found
[here](./plugins.md#manifestLoader).
[here](./plugins.md#manifestloader).

## How to import this feature

Expand Down
2 changes: 1 addition & 1 deletion doc/api/Miscellaneous/MetaPlaylist.md
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,7 @@ player.loadVideo({
```

More infos on the `manifestLoader` can be found
[here](./plugins.md#manifestLoader).
[here](./plugins.md#manifestloader).

### Defining an initial position for a dynamic MetaPlaylist

Expand Down
12 changes: 6 additions & 6 deletions doc/api/Player_Errors.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ Among its properties, you have:
### MEDIA_ERROR

Error related to the media itself. It can both come from the player itself
([Manifest](../Getting_Started/Glossary.md#structure_of_a_manifest_object)
([Manifest](../Getting_Started/Glossary.md#manifest)
parsing) or from the browser itself (content playback).

They all have a `type` property equal to `"MEDIA_ERROR"`.
Expand Down Expand Up @@ -135,7 +135,7 @@ An error of `type` `MEDIA_ERROR` can have the following codes (`code` property):
linked to that codec by inspecting the error's `tracksInfo` property, described below.

- `"MANIFEST_PARSE_ERROR"`: Generic error to signal than the
[Manifest](../Getting_Started/Glossary.md#structure_of_a_manifest_object) could not be parsed.
[Manifest](../Getting_Started/Glossary.md#manifest) could not be parsed.

- `"MANIFEST_UNSUPPORTED_ADAPTATION_TYPE"`: One of the
[Adaptation](../Getting_Started/Glossary.md#adaptation) has a type (e.g. "audio", "text" or
Expand Down Expand Up @@ -186,13 +186,13 @@ An error of `type` `MEDIA_ERROR` can have the following codes (`code` property):

- `"MEDIA_TIME_BEFORE_MANIFEST"`: The current time in the media is behind
what is currently declared in the
[Manifest](../Getting_Started/Glossary.md#structure_of_a_manifest_object).
[Manifest](../Getting_Started/Glossary.md#manifest).
This can lead to stalling indefinitely as the player won't be able to
download new segments arround the current time.

- `"MEDIA_TIME_AFTER_MANIFEST"`: The current time in the media is after what
is currently declared in the
[Manifest](../Getting_Started/Glossary.md#structure_of_a_manifest_object).
[Manifest](../Getting_Started/Glossary.md#manifest).
This can lead to stalling indefinitely as the player won't be able to
download new segments arround the current time.

Expand Down Expand Up @@ -501,12 +501,12 @@ They all have a `type` property equal to `"OTHER_ERROR"`.
An error of `type` `OTHER_ERROR` can have the following codes (`code` property):

- `"PIPELINE_LOAD_ERROR"`: The
[Manifest](../Getting_Started/Glossary.md#structure_of_a_manifest_object) or segment
[Manifest](../Getting_Started/Glossary.md#manifest) or segment
request failed and the request has been done through a given callback (i.e.
not the RxPlayer's XMLHttpRequest implementation).

- `"PIPELINE_PARSE_ERROR"`: The RxPlayer's
[Manifest](../Getting_Started/Glossary.md#structure_of_a_manifest_object)
[Manifest](../Getting_Started/Glossary.md#manifest)
or segment parsing logic failed. This is most likely due to a malformed
Manifest or segment.

Expand Down
13 changes: 5 additions & 8 deletions doc/reference/API_Reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ properties, methods, events and so on.

## Constructor options

- [`videoElement`](../api/Creating_a_Player.md#videoElement): specifies the
- [`videoElement`](../api/Creating_a_Player.md#videoelement): specifies the
media element on which the content will play.

- [`baseBandwidth`](../api/Creating_a_Player.md#basebandwidth):
Expand Down Expand Up @@ -55,7 +55,7 @@ properties, methods, events and so on.
- [`url`](../api/Loading_a_Content.md#url): URL to the content (e.g. DASH's
MPD, Smooth's Manifest etc.)

- [`keySystems`](../api/Decryption_Options.md#loadvideo_%60keysystems%60_options):
- [`keySystems`](../api/Decryption_Options.md#loadvideo-keysystems-options):
DRM configuration for the content.

- [`keySystems[].type`](../api/Decryption_Options.md#type): Name of the
Expand All @@ -71,7 +71,7 @@ properties, methods, events and so on.
Eventual certificate encrypting exchanges between the CDM and license
server.

- [`keySystems[].persistentLicenseConfig`](../api/Decryption_Options.md#persistentLicenseConfig):
- [`keySystems[].persistentLicenseConfig`](../api/Decryption_Options.md#persistentlicenseconfig):
Allows to ask for the DRM session to persist the license.

- [`keySystems[].onKeyExpiration`](../api/Decryption_Options.md#onkeyexpiration):
Expand Down Expand Up @@ -106,11 +106,11 @@ properties, methods, events and so on.
Allows the configuration of the [persistentState](https://www.w3.org/TR/encrypted-media/#dom-mediakeysystemconfiguration-persistentstate)
property.

- [`keySystems[].audioCapabilitiesConfig`](../api/Decryption_Options.md#videocapabilitiesconfigaudiocapabilitiesconfig):
- [`keySystems[].audioCapabilitiesConfig`](../api/Decryption_Options.md#videocapabilitiesconfig--audiocapabilitiesconfig):
Allows the configuration of the [`audioCapabilities`](https://www.w3.org/TR/encrypted-media/#dom-mediakeysystemconfiguration-audiocapabilities)
property.

- [`keySystems[].videoCapabilitiesConfig`](../api/Decryption_Options.md#videocapabilitiesconfigaudiocapabilitiesconfig):
- [`keySystems[].videoCapabilitiesConfig`](../api/Decryption_Options.md#videocapabilitiesconfig--audiocapabilitiesconfig):
Allows the configuration of the [`videoCapabilities`](https://www.w3.org/TR/encrypted-media/#dom-mediakeysystemconfiguration-videocapabilities)
property.

Expand Down Expand Up @@ -478,9 +478,6 @@ properties, methods, events and so on.
Representations previously being locked was automatically unlocked by the
RxPlayer.

- [`autoTrackSwitch`](../api/Player_Events.md#autotrackswitch):
A track previously set was automatically changed by the RxPlayer.

- [`play`](../api/Player_Events.md#play):
Emitted when playback is no longer consider paused.

Expand Down
Loading

0 comments on commit 6c27c67

Please sign in to comment.