docs: review and clean up (#3730)

* fix(ts): onPlaybackRateChangeData was not correctly typed

* fix: ensure tracks are well displayed in the sample

* chore: reorder drm props

* chore: reorder events

* docs: move onAudioTracks to events

* docs: reorder and clean <PlatformsList from methods

* docs: fix props case naming

* docs: fix ordering

* docs: fix ordering & remove trackId

* chore: remove sample build from installation page

* docs: remove outdated information

* docs: remove beta information from doc landing page
This commit is contained in:
Olivier Bouillet
2024-05-04 14:36:39 +02:00
committed by GitHub
parent edbb3b60aa
commit 4c63988d12
9 changed files with 104 additions and 182 deletions

View File

@@ -12,6 +12,14 @@ This page shows the list of available methods
Take the player out of fullscreen mode.
### `pause`
<PlatformsList types={['Android', 'iOS']} />
`pause(): Promise<void>`
Pause the video.
### `presentFullscreenPlayer`
<PlatformsList types={['Android', 'iOS']} />
@@ -24,14 +32,6 @@ On iOS, this displays the video in a fullscreen view controller with controls.
On Android, this puts the navigation controls in fullscreen mode. It is not a complete fullscreen implementation, so you will still need to apply a style that makes the width and height match your screen dimensions to get a fullscreen video.
### `pause`
<PlatformsList types={['Android', 'iOS']} />
`pause(): Promise<void>`
Pause the video.
### `resume`
<PlatformsList types={['Android', 'iOS']} />
@@ -40,6 +40,14 @@ Pause the video.
Resume the video.
### `restoreUserInterfaceForPictureInPictureStopCompleted`
<PlatformsList types={['iOS']} />
`restoreUserInterfaceForPictureInPictureStopCompleted(restored)`
This function corresponds to the completion handler in Apple's [restoreUserInterfaceForPictureInPictureStop](https://developer.apple.com/documentation/avkit/avpictureinpicturecontrollerdelegate/1614703-pictureinpicturecontroller?language=objc). IMPORTANT: This function must be called after `onRestoreUserInterfaceForPictureInPictureStop` is called.
### `save`
<PlatformsList types={['iOS']} />
@@ -64,14 +72,6 @@ Future:
- Will support more formats in the future through options
- Will support custom directory and file name through options
### `restoreUserInterfaceForPictureInPictureStopCompleted`
<PlatformsList types={['iOS']} />
`restoreUserInterfaceForPictureInPictureStopCompleted(restored)`
This function corresponds to the completion handler in Apple's [restoreUserInterfaceForPictureInPictureStop](https://developer.apple.com/documentation/avkit/avpictureinpicturecontrollerdelegate/1614703-pictureinpicturecontroller?language=objc). IMPORTANT: This function must be called after `onRestoreUserInterfaceForPictureInPictureStop` is called.
### `seek`
<PlatformsList types={['All']} />
@@ -143,6 +143,8 @@ Possible values are:
### `isCodecSupported`
<PlatformsList types={['Android']} />
Indicates whether the provided codec is supported level supported by device.
parameters:
@@ -156,14 +158,12 @@ Possible results:
- `software` - codec is supported by software only
- `unsupported` - codec is not supported
<PlatformsList types={['Android']} />
### `isHEVCSupported`
Helper which Indicates whether the provided HEVC/1920\*1080 is supported level supported by device. It uses isCodecSupported internally.
<PlatformsList types={['Android']} />
Helper which Indicates whether the provided HEVC/1920\*1080 is supported level supported by device. It uses isCodecSupported internally.
### Example Usage
```tsx