Skip to content

Commit

Permalink
docs: Fix delete() link
Browse files Browse the repository at this point in the history
  • Loading branch information
mrousavy committed Jul 10, 2024
1 parent 147dd0b commit c69de2a
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
8 changes: 6 additions & 2 deletions package/src/Camera.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,12 @@ function isSkiaFrameProcessor(frameProcessor?: ReadonlyFrameProcessor | Drawable
*
* The `<Camera>` component's most important properties are:
*
* * {@linkcode CameraProps.device | device}: Specifies the {@linkcode CameraDevice} to use. Get a {@linkcode CameraDevice} by using the {@linkcode useCameraDevice | useCameraDevice(..)} hook, or manually by using the {@linkcode CameraDevices.getAvailableCameraDevices CameraDevices.getAvailableCameraDevices()} function.
* * {@linkcode CameraProps.isActive | isActive}: A boolean value that specifies whether the Camera should actively stream video frames or not. This can be compared to a Video component, where `isActive` specifies whether the video is paused or not. If you fully unmount the `<Camera>` component instead of using `isActive={false}`, the Camera will take a bit longer to start again.
* * {@linkcode CameraProps.device | device}: Specifies the {@linkcode CameraDevice} to use. Get a {@linkcode CameraDevice} by using
* the {@linkcode useCameraDevice | useCameraDevice(..)} hook, or manually by using
* the {@linkcode CameraDevices.getAvailableCameraDevices | CameraDevices.getAvailableCameraDevices()} function.
* * {@linkcode CameraProps.isActive | isActive}: A boolean value that specifies whether the Camera should
* actively stream video frames or not. This can be compared to a Video component, where `isActive` specifies whether the video
* is paused or not. If you fully unmount the `<Camera>` component instead of using `isActive={false}`, the Camera will take a bit longer to start again.
*
* @example
* ```tsx
Expand Down
2 changes: 1 addition & 1 deletion package/src/types/Frame.ts
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ export interface Frame {
* - On iOS, this is a `CVPixelBufferRef`
*
* The native buffer needs to be manually deleted using
* {@linkcode NativeBuffer.delete()}, and this {@linkcode Frame}
* {@linkcode NativeBuffer.delete | NativeBuffer.delete()}, and this {@linkcode Frame}
* needs to be kept alive as long as-, or longer than
* the {@linkcode NativeBuffer}.
*/
Expand Down

0 comments on commit c69de2a

Please sign in to comment.