diff --git a/documentation/docs/api/classes/CameraCaptureError.md b/documentation/docs/api/classes/CameraCaptureError.md index acf8ac4..447fed8 100644 --- a/documentation/docs/api/classes/CameraCaptureError.md +++ b/documentation/docs/api/classes/CameraCaptureError.md @@ -30,7 +30,7 @@ CameraError.cause #### Defined in -[CameraKitModule/CameraError.ts:130](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/51f1638/src/CameraKitModule/CameraError.ts#L130) +[CameraKitModule/CameraError.ts:130](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/CameraError.ts#L130) ___ @@ -48,7 +48,7 @@ CameraError.code #### Defined in -[CameraKitModule/CameraError.ts:124](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/51f1638/src/CameraKitModule/CameraError.ts#L124) +[CameraKitModule/CameraError.ts:124](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/CameraError.ts#L124) ___ @@ -66,7 +66,7 @@ CameraError.message #### Defined in -[CameraKitModule/CameraError.ts:127](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/51f1638/src/CameraKitModule/CameraError.ts#L127) +[CameraKitModule/CameraError.ts:127](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/CameraError.ts#L127) ## Methods @@ -84,4 +84,4 @@ CameraError.toString #### Defined in -[CameraKitModule/CameraError.ts:152](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/51f1638/src/CameraKitModule/CameraError.ts#L152) +[CameraKitModule/CameraError.ts:152](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/CameraError.ts#L152) diff --git a/documentation/docs/api/classes/CameraRuntimeError.md b/documentation/docs/api/classes/CameraRuntimeError.md index c4c2472..8230a30 100644 --- a/documentation/docs/api/classes/CameraRuntimeError.md +++ b/documentation/docs/api/classes/CameraRuntimeError.md @@ -30,7 +30,7 @@ CameraError.cause #### Defined in -[CameraKitModule/CameraError.ts:130](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/51f1638/src/CameraKitModule/CameraError.ts#L130) +[CameraKitModule/CameraError.ts:130](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/CameraError.ts#L130) ___ @@ -48,7 +48,7 @@ CameraError.code #### Defined in -[CameraKitModule/CameraError.ts:124](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/51f1638/src/CameraKitModule/CameraError.ts#L124) +[CameraKitModule/CameraError.ts:124](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/CameraError.ts#L124) ___ @@ -66,7 +66,7 @@ CameraError.message #### Defined in -[CameraKitModule/CameraError.ts:127](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/51f1638/src/CameraKitModule/CameraError.ts#L127) +[CameraKitModule/CameraError.ts:127](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/CameraError.ts#L127) ## Methods @@ -84,4 +84,4 @@ CameraError.toString #### Defined in -[CameraKitModule/CameraError.ts:152](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/51f1638/src/CameraKitModule/CameraError.ts#L152) +[CameraKitModule/CameraError.ts:152](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/CameraError.ts#L152) diff --git a/documentation/docs/api/classes/default.md b/documentation/docs/api/classes/default.md new file mode 100644 index 0000000..a892732 --- /dev/null +++ b/documentation/docs/api/classes/default.md @@ -0,0 +1,363 @@ +--- +id: "default" +title: "Class: default" +sidebar_label: "default" +sidebar_position: 0 +custom_edit_url: null +--- + +## Hierarchy + +- `PureComponent`<`CameraKitProps`\> + + ↳ **`default`** + +## Constructors + +### constructor + +• **new default**(`props`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `props` | `CameraKitProps` | + +#### Overrides + +React.PureComponent<CameraKitProps\>.constructor + +#### Defined in + +[CameraKitModule/index.tsx:145](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/index.tsx#L145) + +## Properties + +### defaultProps + +▪ `Static` **defaultProps**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `initialCameraFacing` | `string` | +| `initialLens` | ``null`` | +| `isActive` | `boolean` | +| `lensGroups` | ``null`` | + +#### Defined in + +[CameraKitModule/index.tsx:136](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/index.tsx#L136) + +## Methods + +### adjustBlur + +▸ **adjustBlur**(`amount`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `amount` | `number` | + +#### Returns + +`void` + +#### Defined in + +[CameraKitModule/index.tsx:250](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/index.tsx#L250) + +___ + +### adjustLensesVolume + +▸ **adjustLensesVolume**(`mute`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `mute` | `Boolean` | + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[CameraKitModule/index.tsx:357](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/index.tsx#L357) + +___ + +### adjustTone + +▸ **adjustTone**(`amount`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `amount` | `number` | + +#### Returns + +`void` + +#### Defined in + +[CameraKitModule/index.tsx:254](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/index.tsx#L254) + +___ + +### cancelRecording + +▸ **cancelRecording**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[CameraKitModule/index.tsx:399](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/index.tsx#L399) + +___ + +### changeLensById + +▸ **changeLensById**(`lensId`, `options?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `lensId` | `string` | +| `options?` | `ChangeLensByIdOptions` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[CameraKitModule/index.tsx:290](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/index.tsx#L290) + +___ + +### checkBlurSupporting + +▸ **checkBlurSupporting**(): `Promise`<`boolean`\> + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[CameraKitModule/index.tsx:233](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/index.tsx#L233) + +___ + +### checkToneModeSupporting + +▸ **checkToneModeSupporting**(): `Promise`<`boolean`\> + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[CameraKitModule/index.tsx:216](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/index.tsx#L216) + +___ + +### clearLenses + +▸ **clearLenses**(): `Promise`<`boolean`\> + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[CameraKitModule/index.tsx:340](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/index.tsx#L340) + +___ + +### flipCamera + +▸ **flipCamera**(): `Promise`<`CameraPosition`\> + +#### Returns + +`Promise`<`CameraPosition`\> + +#### Defined in + +[CameraKitModule/index.tsx:266](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/index.tsx#L266) + +___ + +### focus + +▸ **focus**(`point`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `point` | `Point` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[CameraKitModule/index.tsx:282](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/index.tsx#L282) + +___ + +### getLenses + +▸ **getLenses**(`lensGroup?`): `Promise`<[`Lens`](../interfaces/Lens.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `lensGroup?` | `string` | + +#### Returns + +`Promise`<[`Lens`](../interfaces/Lens.md)[]\> + +#### Defined in + +[CameraKitModule/index.tsx:315](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/index.tsx#L315) + +___ + +### pauseRecording + +▸ **pauseRecording**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[CameraKitModule/index.tsx:383](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/index.tsx#L383) + +___ + +### render + +▸ **render**(): `Element` + +#### Returns + +`Element` + +#### Overrides + +React.PureComponent.render + +#### Defined in + +[CameraKitModule/index.tsx:415](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/index.tsx#L415) + +___ + +### resumeRecording + +▸ **resumeRecording**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[CameraKitModule/index.tsx:391](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/index.tsx#L391) + +___ + +### startRecording + +▸ **startRecording**(`options`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options` | `RecordVideoOptions` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[CameraKitModule/index.tsx:375](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/index.tsx#L375) + +___ + +### stopRecording + +▸ **stopRecording**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[CameraKitModule/index.tsx:407](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/index.tsx#L407) + +___ + +### takePhoto + +▸ **takePhoto**(`options?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options?` | `TakePhotoOptions` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[CameraKitModule/index.tsx:258](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/index.tsx#L258) + +___ + +### zoom + +▸ **zoom**(`factor`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `factor` | `number` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[CameraKitModule/index.tsx:274](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/index.tsx#L274) diff --git a/documentation/docs/api/index.md b/documentation/docs/api/index.md index 1993f72..e2d4016 100644 --- a/documentation/docs/api/index.md +++ b/documentation/docs/api/index.md @@ -10,10 +10,13 @@ custom_edit_url: null - [CameraCaptureError](classes/CameraCaptureError.md) - [CameraRuntimeError](classes/CameraRuntimeError.md) +- [default](classes/default.md) ## Interfaces - [ErrorWithCause](interfaces/ErrorWithCause.md) +- [Lens](interfaces/Lens.md) +- [VideoMetadata](interfaces/VideoMetadata.md) ## Type Aliases @@ -23,7 +26,52 @@ custom_edit_url: null #### Defined in -[CameraKitModule/CameraError.ts:53](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/51f1638/src/CameraKitModule/CameraError.ts#L53) +[CameraKitModule/CameraError.ts:53](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/CameraError.ts#L53) + +___ + +### CameraPermissionRequestStatus + +Ƭ **CameraPermissionRequestStatus**: ``"authorized"`` \| ``"denied"`` + +#### Defined in + +[CameraPermissionsModule/index.ts:15](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraPermissionsModule/index.ts#L15) + +___ + +### CameraPermissionStatus + +Ƭ **CameraPermissionStatus**: ``"authorized"`` \| ``"not-determined"`` \| ``"denied"`` \| ``"restricted"`` + +#### Defined in + +[CameraPermissionsModule/index.ts:17](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraPermissionsModule/index.ts#L17) + +___ + +### CameraPreset + +Ƭ **CameraPreset**: ``"cif-352x288"`` \| ``"hd-1280x720"`` \| ``"hd-1920x1080"`` \| ``"hd-3840x2160"`` \| ``"high"`` \| ``"iframe-1280x720"`` \| ``"iframe-960x540"`` \| ``"input-priority"`` \| ``"low"`` \| ``"medium"`` \| ``"photo"`` \| ``"vga-640x480"`` + +Indicates the quality level or bit rate of the output. + +* `"cif-352x288"`: Specifies capture settings suitable for CIF quality (352 x 288 pixel) video output +* `"hd-1280x720"`: Specifies capture settings suitable for 720p quality (1280 x 720 pixel) video output. +* `"hd-1920x1080"`: Capture settings suitable for 1080p-quality (1920 x 1080 pixels) video output. +* `"hd-3840x2160"`: Capture settings suitable for 2160p-quality (3840 x 2160 pixels, "4k") video output. +* `"high"`: Specifies capture settings suitable for high-quality video and audio output. +* `"iframe-1280x720"`: Specifies capture settings to achieve 1280 x 720 quality iFrame H.264 video at about 40 Mbits/sec with AAC audio. +* `"iframe-960x540"`: Specifies capture settings to achieve 960 x 540 quality iFrame H.264 video at about 30 Mbits/sec with AAC audio. +* `"input-priority"`: Specifies that the capture session does not control audio and video output settings. +* `"low"`: Specifies capture settings suitable for output video and audio bit rates suitable for sharing over 3G. +* `"medium"`: Specifies capture settings suitable for output video and audio bit rates suitable for sharing over WiFi. +* `"photo"`: Specifies capture settings suitable for high-resolution photo quality output. +* `"vga-640x480"`: Specifies capture settings suitable for VGA quality (640 x 480 pixel) video output. + +#### Defined in + +[CameraKitModule/index.tsx:69](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/index.tsx#L69) ___ @@ -33,7 +81,7 @@ ___ #### Defined in -[CameraKitModule/CameraError.ts:30](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/51f1638/src/CameraKitModule/CameraError.ts#L30) +[CameraKitModule/CameraError.ts:30](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/CameraError.ts#L30) ___ @@ -43,7 +91,7 @@ ___ #### Defined in -[CameraKitModule/CameraError.ts:10](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/51f1638/src/CameraKitModule/CameraError.ts#L10) +[CameraKitModule/CameraError.ts:10](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/CameraError.ts#L10) ___ @@ -53,7 +101,7 @@ ___ #### Defined in -[CameraKitModule/CameraError.ts:20](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/51f1638/src/CameraKitModule/CameraError.ts#L20) +[CameraKitModule/CameraError.ts:20](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/CameraError.ts#L20) ___ @@ -63,7 +111,7 @@ ___ #### Defined in -[CameraKitModule/CameraError.ts:19](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/51f1638/src/CameraKitModule/CameraError.ts#L19) +[CameraKitModule/CameraError.ts:19](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/CameraError.ts#L19) ___ @@ -73,7 +121,7 @@ ___ #### Defined in -[CameraKitModule/CameraError.ts:4](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/51f1638/src/CameraKitModule/CameraError.ts#L4) +[CameraKitModule/CameraError.ts:4](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/CameraError.ts#L4) ___ @@ -83,7 +131,7 @@ ___ #### Defined in -[CameraKitModule/CameraError.ts:1](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/51f1638/src/CameraKitModule/CameraError.ts#L1) +[CameraKitModule/CameraError.ts:1](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/CameraError.ts#L1) ___ @@ -93,7 +141,7 @@ ___ #### Defined in -[CameraKitModule/CameraError.ts:25](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/51f1638/src/CameraKitModule/CameraError.ts#L25) +[CameraKitModule/CameraError.ts:25](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/CameraError.ts#L25) ___ @@ -103,7 +151,7 @@ ___ #### Defined in -[CameraKitModule/CameraError.ts:52](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/51f1638/src/CameraKitModule/CameraError.ts#L52) +[CameraKitModule/CameraError.ts:52](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/CameraError.ts#L52) ___ @@ -113,10 +161,79 @@ ___ #### Defined in -[CameraKitModule/CameraError.ts:54](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/51f1638/src/CameraKitModule/CameraError.ts#L54) +[CameraKitModule/CameraError.ts:54](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/CameraError.ts#L54) + +## Variables + +### CameraPermissionManager + +• **CameraPermissionManager**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `getCameraPermissionStatus` | () => `Promise`<[`CameraPermissionStatus`](#camerapermissionstatus)\> | +| `getMicrophonePermissionStatus` | () => `Promise`<[`CameraPermissionStatus`](#camerapermissionstatus)\> | +| `requestCameraPermission` | () => `Promise`<[`CameraPermissionRequestStatus`](#camerapermissionrequeststatus)\> | +| `requestMicrophonePermission` | () => `Promise`<[`CameraPermissionRequestStatus`](#camerapermissionrequeststatus)\> | + +#### Defined in + +[CameraPermissionsModule/index.ts:23](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraPermissionsModule/index.ts#L23) + +___ + +### VideoUtils + +• **VideoUtils**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `getMetadata` | (`path`: `String`) => `Promise`<[`VideoMetadata`](interfaces/VideoMetadata.md)\> | + +#### Defined in + +[VideoUtilsModule/index.ts:61](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/VideoUtilsModule/index.ts#L61) ## Functions +### getMetadata + +▸ **getMetadata**(): `Promise`<`Meta`\> + +#### Returns + +`Promise`<`Meta`\> + +#### Defined in + +[CameraKitModule/index.tsx:454](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/index.tsx#L454) + +___ + +### init + +▸ **init**(`options`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options` | `InitOptions` | + +#### Returns + +`void` + +#### Defined in + +[CameraKitModule/index.tsx:450](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/index.tsx#L450) + +___ + ### isErrorWithCause ▸ **isErrorWithCause**(`error`): error is ErrorWithCause @@ -137,7 +254,7 @@ error is ErrorWithCause #### Defined in -[CameraKitModule/CameraError.ts:182](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/51f1638/src/CameraKitModule/CameraError.ts#L182) +[CameraKitModule/CameraError.ts:182](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/CameraError.ts#L182) ___ @@ -169,4 +286,4 @@ A [`CameraRuntimeError`](classes/CameraRuntimeError.md) or [`CameraCaptureError` #### Defined in -[CameraKitModule/CameraError.ts:210](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/51f1638/src/CameraKitModule/CameraError.ts#L210) +[CameraKitModule/CameraError.ts:210](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/CameraError.ts#L210) diff --git a/documentation/docs/api/interfaces/ErrorWithCause.md b/documentation/docs/api/interfaces/ErrorWithCause.md index 66b4a62..c8df43f 100644 --- a/documentation/docs/api/interfaces/ErrorWithCause.md +++ b/documentation/docs/api/interfaces/ErrorWithCause.md @@ -21,7 +21,7 @@ Optional additional cause for nested errors #### Defined in -[CameraKitModule/CameraError.ts:101](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/51f1638/src/CameraKitModule/CameraError.ts#L101) +[CameraKitModule/CameraError.ts:101](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/CameraError.ts#L101) ___ @@ -36,7 +36,7 @@ The native error's code. #### Defined in -[CameraKitModule/CameraError.ts:66](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/51f1638/src/CameraKitModule/CameraError.ts#L66) +[CameraKitModule/CameraError.ts:66](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/CameraError.ts#L66) ___ @@ -51,7 +51,7 @@ Optional additional details #### Defined in -[CameraKitModule/CameraError.ts:87](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/51f1638/src/CameraKitModule/CameraError.ts#L87) +[CameraKitModule/CameraError.ts:87](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/CameraError.ts#L87) ___ @@ -66,7 +66,7 @@ The native error's domain. #### Defined in -[CameraKitModule/CameraError.ts:73](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/51f1638/src/CameraKitModule/CameraError.ts#L73) +[CameraKitModule/CameraError.ts:73](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/CameraError.ts#L73) ___ @@ -81,7 +81,7 @@ The native error description #### Defined in -[CameraKitModule/CameraError.ts:80](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/51f1638/src/CameraKitModule/CameraError.ts#L80) +[CameraKitModule/CameraError.ts:80](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/CameraError.ts#L80) ___ @@ -96,4 +96,4 @@ Optional Java stacktrace #### Defined in -[CameraKitModule/CameraError.ts:94](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/51f1638/src/CameraKitModule/CameraError.ts#L94) +[CameraKitModule/CameraError.ts:94](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/CameraError.ts#L94) diff --git a/documentation/docs/api/interfaces/Lens.md b/documentation/docs/api/interfaces/Lens.md new file mode 100644 index 0000000..88dfffc --- /dev/null +++ b/documentation/docs/api/interfaces/Lens.md @@ -0,0 +1,81 @@ +--- +id: "Lens" +title: "Interface: Lens" +sidebar_label: "Lens" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### facingPreference + +• **facingPreference**: `CameraPosition` + +#### Defined in + +[CameraKitModule/interfaces/Lens.ts:27](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/interfaces/Lens.ts#L27) + +___ + +### groupId + +• **groupId**: `string` + +#### Defined in + +[CameraKitModule/interfaces/Lens.ts:25](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/interfaces/Lens.ts#L25) + +___ + +### icons + +• **icons**: `Image`[] + +#### Defined in + +[CameraKitModule/interfaces/Lens.ts:28](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/interfaces/Lens.ts#L28) + +___ + +### id + +• **id**: `string` + +#### Defined in + +[CameraKitModule/interfaces/Lens.ts:24](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/interfaces/Lens.ts#L24) + +___ + +### name + +• **name**: `string` + +#### Defined in + +[CameraKitModule/interfaces/Lens.ts:26](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/interfaces/Lens.ts#L26) + +___ + +### previews + +• **previews**: `Image`[] + +#### Defined in + +[CameraKitModule/interfaces/Lens.ts:29](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/interfaces/Lens.ts#L29) + +___ + +### vendorData + +• **vendorData**: `Object` + +#### Index signature + +▪ [key: `string`]: `string` + +#### Defined in + +[CameraKitModule/interfaces/Lens.ts:30](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/CameraKitModule/interfaces/Lens.ts#L30) diff --git a/documentation/docs/api/interfaces/VideoMetadata.md b/documentation/docs/api/interfaces/VideoMetadata.md new file mode 100644 index 0000000..0dca6e0 --- /dev/null +++ b/documentation/docs/api/interfaces/VideoMetadata.md @@ -0,0 +1,111 @@ +--- +id: "VideoMetadata" +title: "Interface: VideoMetadata" +sidebar_label: "VideoMetadata" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### audioCodec + +• **audioCodec**: `string` + +Audio codec. + +**`Platform`** + +Android + +#### Defined in + +[VideoUtilsModule/index.ts:41](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/VideoUtilsModule/index.ts#L41) + +___ + +### duration + +• **duration**: `number` + +Duration of the video in seconds. + +#### Defined in + +[VideoUtilsModule/index.ts:34](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/VideoUtilsModule/index.ts#L34) + +___ + +### frameRate + +• **frameRate**: `number` + +The average framerate (in frames/sec). + +#### Defined in + +[VideoUtilsModule/index.ts:29](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/VideoUtilsModule/index.ts#L29) + +___ + +### height + +• **height**: `number` + +Video height. + +#### Defined in + +[VideoUtilsModule/index.ts:58](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/VideoUtilsModule/index.ts#L58) + +___ + +### path + +• **path**: `string` + +The path of the file. + +#### Defined in + +[VideoUtilsModule/index.ts:19](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/VideoUtilsModule/index.ts#L19) + +___ + +### size + +• **size**: `number` + +File size in bytes. + +#### Defined in + +[VideoUtilsModule/index.ts:24](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/VideoUtilsModule/index.ts#L24) + +___ + +### videoCodec + +• **videoCodec**: `string` + +Video codec. + +**`Platform`** + +Android + +#### Defined in + +[VideoUtilsModule/index.ts:48](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/VideoUtilsModule/index.ts#L48) + +___ + +### width + +• **width**: `number` + +Video width. + +#### Defined in + +[VideoUtilsModule/index.ts:53](https://github.com/popile-media/react-native-snapchat-camera-kit/blob/970158e/src/VideoUtilsModule/index.ts#L53) diff --git a/documentation/docusaurus.config.js b/documentation/docusaurus.config.js index 05c47ea..a5c589a 100644 --- a/documentation/docusaurus.config.js +++ b/documentation/docusaurus.config.js @@ -119,21 +119,25 @@ const config = { title: 'More', items: [ { - label: 'Offical Site', - href: 'https://ar.snap.com/camera-kit', - }, - { - label: 'Offical Documentation', - href: 'https://docs.snap.com/camera-kit/home', - }, - { - label: 'Request Access', - href: 'https://camera-kit.snapchat.com/request', - }, - { - label: 'Forum', - href: 'https://community.snap.com/snapar/categories/camera-kit', + label: 'Discussions', + href: 'https://github.com/popile-media/react-native-snapchat-camera-kit/discussions', }, + // { + // label: 'Offical Site', + // href: 'https://ar.snap.com/camera-kit', + // }, + // { + // label: 'Offical Documentation', + // href: 'https://docs.snap.com/camera-kit/home', + // }, + // { + // label: 'Request Access', + // href: 'https://camera-kit.snapchat.com/request', + // }, + // { + // label: 'Forum', + // href: 'https://community.snap.com/snapar/categories/camera-kit', + // }, ], }, ], diff --git a/documentation/src/components/HomepageFeatures/index.tsx b/documentation/src/components/HomepageFeatures/index.tsx index 0faed44..1bef557 100644 --- a/documentation/src/components/HomepageFeatures/index.tsx +++ b/documentation/src/components/HomepageFeatures/index.tsx @@ -24,19 +24,16 @@ const FeatureList: FeatureItem[] = [ Svg: require('@site/static/img/lens-studio.svg').default, description: ( <> - Easily integrate the AR into your React Native App and avoid dealing with - native development. + Easily integrate the AR into your React Native App and avoid dealing + with native development. ), }, { - title: 'Powered by Snapchat', - Svg: require('@site/static/img/snapchat-logo.svg').default, + title: 'AR Integration Made Effortless', + Svg: require('@site/static/img/logo.svg').default, description: ( - <> - The library was not written by the Snapchat Team, but we are using - Snapchat's CameraKit SDK in the background. - + <>Concentrate on your project's core objectives without distractions. ), }, ]; diff --git a/documentation/static/img/camera.png b/documentation/static/img/camera.png new file mode 100644 index 0000000..06fb518 Binary files /dev/null and b/documentation/static/img/camera.png differ diff --git a/documentation/static/img/favicon.ico b/documentation/static/img/favicon.ico index 6398b5e..bff5d1d 100644 Binary files a/documentation/static/img/favicon.ico and b/documentation/static/img/favicon.ico differ diff --git a/documentation/static/img/logo.svg b/documentation/static/img/logo.svg index a304268..3aad8a1 100644 --- a/documentation/static/img/logo.svg +++ b/documentation/static/img/logo.svg @@ -1 +1,4 @@ - \ No newline at end of file + + + + \ No newline at end of file diff --git a/documentation/static/img/snapchat-logo.svg b/documentation/static/img/snapchat-logo.svg deleted file mode 100644 index e2c7146..0000000 --- a/documentation/static/img/snapchat-logo.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file