@snap/camera-kit 1.0.1 → 1.2.0

package/docs/md/classes/CameraKitSession.md

@@ -1,4 +1,8 @@
-[CameraKit Web SDK - v1.0.1](../README.md) / [Exports](../modules.md) / CameraKitSession
+[**CameraKit Web SDK v1.2.0**](../README.md)
+
+***
+
+[CameraKit Web SDK](../globals.md) / CameraKitSession
 
 # Class: CameraKitSession
 
@@ -10,40 +14,18 @@ CameraKitSession is the primary object that applications interact with when inte
 
 A CameraKitSession instance is obtained by calling [CameraKit.createSession](CameraKit.md#createsession).
 
-**`Example`**
+## Example
 
 ```ts
 const cameraKit = await bootstrapCameraKit(config)
 const session = await cameraKit.createSession()
 ```
 
-## Table of contents
-
-### Properties
-
-- [output](CameraKitSession.md#output)
-- [playing](CameraKitSession.md#playing)
-- [events](CameraKitSession.md#events)
-- [metrics](CameraKitSession.md#metrics)
-- [keyboard](CameraKitSession.md#keyboard)
-
-### Methods
-
-- [applyLens](CameraKitSession.md#applylens)
-- [removeLens](CameraKitSession.md#removelens)
-- [play](CameraKitSession.md#play)
-- [pause](CameraKitSession.md#pause)
-- [mute](CameraKitSession.md#mute)
-- [unmute](CameraKitSession.md#unmute)
-- [setSource](CameraKitSession.md#setsource)
-- [setFPSLimit](CameraKitSession.md#setfpslimit)
-- [destroy](CameraKitSession.md#destroy)
-
 ## Properties
 
 ### output
 
-• `Readonly` **output**: `Object`
+> `readonly` **output**: `object`
 
 CameraKitSession renders video output to a `<canvas>` element. In fact, each session contains two canvas outputs
 corresponding to the RenderTargets used by Lens creators, when using LensStudio to create a Lens.
@@ -55,42 +37,44 @@ other users (e.g. sent to the other members of a video call, or saved to disk fo
 For many lenses, these outputs are identical – but each lens is free to render differently, based on its own
 use-case.
 
-#### Type declaration
+#### live
 
-| Name | Type |
-| :------ | :------ |
-| `live` | `HTMLCanvasElement` |
-| `capture` | `HTMLCanvasElement` |
+> **live**: `HTMLCanvasElement`
 
-___
+#### capture
+
+> **capture**: `HTMLCanvasElement`
+
+***
 
 ### playing
 
-• **playing**: `Object`
+> **playing**: `object`
 
 Indicates whether or not the session is currently rendering. If `false`, rendering is stopped. Otherwise the
 value indicates which output is being rendered.
 
-#### Type declaration
+#### live
+
+> **live**: `boolean`
+
+#### capture
 
-| Name | Type |
-| :------ | :------ |
-| `live` | `boolean` |
-| `capture` | `boolean` |
+> **capture**: `boolean`
 
-___
+***
 
 ### events
 
-• `Readonly` **events**: [`TypedEventTarget`](TypedEventTarget.md)\<[`CameraKitSessionEvents`](../modules.md#camerakitsessionevents)\>
+> `readonly` **events**: [`TypedEventTarget`](TypedEventTarget.md)\<[`CameraKitSessionEvents`](../type-aliases/CameraKitSessionEvents.md)\>
 
 Add event listeners here to handle events which occur during the CameraKitSession.
 
 **Note:** Applications may want to handle the `error` event, and check the contained error type -- if the type
-is [LensExecutionError](../modules.md#lensexecutionerror), this means the current lens was unable to render and CameraKit will automatically
+is [LensExecutionError](../type-aliases/LensExecutionError.md), this means the current lens was unable to render and CameraKit will automatically
 remove the lens.
 
-**`Example`**
+#### Example
 
 ```ts
 cameraKitSession.events.addEventListener('error', ({ detail }) => {
@@ -100,27 +84,30 @@ cameraKitSession.events.addEventListener('error', ({ detail }) => {
 })
 ```
 
-___
+***
 
 ### metrics
 
-• `Readonly` **metrics**: [`LensPerformanceMetrics`](LensPerformanceMetrics.md)
+> `readonly` **metrics**: [`LensPerformanceMetrics`](LensPerformanceMetrics.md)
 
 Use this to measure current lens performance.
 
-___
+***
 
 ### keyboard
 
-• `Readonly` **keyboard**: [`Keyboard`](../modules.md#keyboard)
+> `readonly` **keyboard**: [`Keyboard`](../interfaces/Keyboard.md)
 
-Use this to interact with lenses which require text input.
+The [Keyboard](../interfaces/Keyboard.md) API enables applications to handle keyboard input requests from lenses.
+When a lens requests a keyboard, the app displays it in its preferred UI. As users type,
+the app sends the text back to the lens for display. The lens can also request keyboard dismissal,
+prompting the app to remove the displayed keyboard.
 
 ## Methods
 
-### applyLens
+### applyLens()
 
-▸ **applyLens**(`lens`, `launchData?`): `Promise`\<`boolean`\>
+> **applyLens**(`lens`, `launchData`?): `Promise`\<`boolean`\>
 
 Apply a Lens to this session.
 
@@ -131,7 +118,7 @@ when session playback in resumed.
 Calling `applyLens` replaces any prior Lens – only one Lens is allowed at a time (per session).
 
 **NOTE**: Errors may occur after the Lens is applied. If the Lens encounters errors while rendering,
-Camera Kit will automatically remove the Lens from the session and emit a [LensExecutionError](../modules.md#lensexecutionerror) event.
+Camera Kit will automatically remove the Lens from the session and emit a [LensExecutionError](../type-aliases/LensExecutionError.md) event.
 Applications may want to listen for this error and, for example,
 prevent the Lens from being selected again by the user.
 
@@ -146,10 +133,18 @@ session.events.addEventListener("error", ({ detail }) => {
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `lens` | [`Lens`](../interfaces/Lens.md) | The Lens to apply to this session. |
-| `launchData?` | [`LensLaunchData`](../interfaces/LensLaunchData.md) | This can optionally be provided to pass some initial data to the Lens – only certain Lenses expect launch data. |
+##### lens
+
+[`Lens`](../interfaces/Lens.md)
+
+The Lens to apply to this session.
+
+##### launchData?
+
+[`LensLaunchData`](../interfaces/LensLaunchData.md)
+
+This can optionally be provided to pass some initial data to the Lens – only certain Lenses
+expect launch data.
 
 #### Returns
 
@@ -165,11 +160,11 @@ subsequent call to `applyLens` interrupted the Lens application.
   - Lens content download fails, or the download of any required lens assets fails.
   - An internal failure occurs in the Lens rendering engine when attempting to apply the Lens.
 
-___
+***
 
-### removeLens
+### removeLens()
 
-▸ **removeLens**(): `Promise`\<`boolean`\>
+> **removeLens**(): `Promise`\<`boolean`\>
 
 Remove a Lens from this session.
 
@@ -187,11 +182,11 @@ session's rendered output will still have a (new) lens applied.
 3. Rejected: the lens has failed to be removed. This can happen if an internal failure occurs in the Lens
 rendering engine when attempting to remove the lens.
 
-___
+***
 
-### play
+### play()
 
-▸ **play**(`target?`): `Promise`\<`void`\>
+> **play**(`target`): `Promise`\<`void`\>
 
 Start/resume session playback – LensCore will begin rendering frames to the output.
 
@@ -200,9 +195,11 @@ processing will occur until `setSource()` is called.
 
 #### Parameters
 
-| Name | Type | Default value | Description |
-| :------ | :------ | :------ | :------ |
-| `target` | [`RenderTarget`](../modules.md#rendertarget) | `"live"` | Specify the [RenderTarget](../modules.md#rendertarget) to render. Defaults to the `live` RenderTarget. |
+##### target
+
+[`RenderTarget`](../type-aliases/RenderTarget.md) = `"live"`
+
+Specify the [RenderTarget](../type-aliases/RenderTarget.md) to render. Defaults to the `live` RenderTarget.
 
 #### Returns
 
@@ -211,7 +208,7 @@ processing will occur until `setSource()` is called.
 Promise resolves when playback state has been updated. If no source has been set, this means `play` will
 resolve before any frames are processed -- but once a source is set, frames will immediately begin processing.
 
-**`Example`**
+#### Example
 
 ```ts
 const cameraKitSession = await cameraKit.createSession()
@@ -222,19 +219,22 @@ await cameraKitSession.play()
 // media source has been set.
 ```
 
-___
+***
 
-### pause
+### pause()
 
-▸ **pause**(`target?`): `Promise`\<`void`\>
+> **pause**(`target`): `Promise`\<`void`\>
 
 Pause session playback – LensCore will stop rendering frames to the output.
 
 #### Parameters
 
-| Name | Type | Default value | Description |
-| :------ | :------ | :------ | :------ |
-| `target` | [`RenderTarget`](../modules.md#rendertarget) | `"live"` | Specify the RenderTarget to pause playback. May be either `'live'` or `'capture'`. Default is `'live'`. |
+##### target
+
+[`RenderTarget`](../type-aliases/RenderTarget.md) = `"live"`
+
+Specify the RenderTarget to pause playback. May be either `'live'` or `'capture'`.
+Default is `'live'`.
 
 #### Returns
 
@@ -242,47 +242,53 @@ Pause session playback – LensCore will stop rendering frames to the output.
 
 Promise resolves when playback has stopped.
 
-___
+***
 
-### mute
+### mute()
 
-▸ **mute**(`fade?`): `void`
+> **mute**(`fade`): `void`
 
 Mute all sounds (default SDK state is unmuted).
 
 #### Parameters
 
-| Name | Type | Default value | Description |
-| :------ | :------ | :------ | :------ |
-| `fade` | `boolean` | `false` | Do we want audio to fade out? |
+##### fade
+
+`boolean` = `false`
+
+Do we want audio to fade out?
 
 #### Returns
 
 `void`
 
-___
+***
 
-### unmute
+### unmute()
 
-▸ **unmute**(`fade?`): `void`
+> **unmute**(`fade`): `void`
 
 Unmute all sounds.
 
 #### Parameters
 
-| Name | Type | Default value | Description |
-| :------ | :------ | :------ | :------ |
-| `fade` | `boolean` | `false` | Do we want audio to fade in? |
+##### fade
+
+`boolean` = `false`
+
+Do we want audio to fade in?
 
 #### Returns
 
 `void`
 
-___
+***
+
+### setSource()
 
-### setSource
+#### Call Signature
 
-▸ **setSource**(`source`): `Promise`\<[`CameraKitSource`](CameraKitSource.md)\>
+> **setSource**(`source`): `Promise`\<[`CameraKitSource`](CameraKitSource.md)\>
 
 Set the media source for this session.
 
@@ -292,22 +298,26 @@ is already playing, setting the source will immediately begin rendering the new
 
 The CameraKit SDK provides implementations for various common sources, which applications can create using the
 following functions:
-- [createMediaStreamSource](../modules.md#createmediastreamsource)
-- [createVideoSource](../modules.md#createvideosource)
-- [createImageSource](../modules.md#createimagesource)
+- [createMediaStreamSource](../functions/createMediaStreamSource.md)
+- [createVideoSource](../functions/createVideoSource.md)
+- [createImageSource](../functions/createImageSource.md)
 
 **Important:** Once a source has been set for a session, it cannot be set again, even if it has been replaced
 by another one. You must provide a new instance of [CameraKitSource](CameraKitSource.md) to [CameraKitSession.setSource](CameraKitSession.md#setsource).
 If you want to reuse the existing source, you can use its [CameraKitSource.copy](CameraKitSource.md#copy) method to create a new
 instance.
 
-#### Parameters
+##### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `source` | [`CameraKitSource`](CameraKitSource.md) | A CameraKitSource object representing input media (e.g. a webcam stream, video, or some other source of image data), which CameraKit will supply to Lenses in order for them to render effects on top of that source. |
+###### source
 
-#### Returns
+[`CameraKitSource`](CameraKitSource.md)
+
+A CameraKitSource object representing input media (e.g. a webcam stream, video, or some other
+source of image data), which CameraKit will supply to Lenses in order for them to render effects on top of that
+source.
+
+##### Returns
 
 `Promise`\<[`CameraKitSource`](CameraKitSource.md)\>
 
@@ -315,24 +325,54 @@ Promise is resolved when the source has successfully been set. If the session wa
 state, the Promise resolves when the first frame from the new source has been rendered. The resolved value is
 the [CameraKitSource](CameraKitSource.md) object attached to the session.
 
-▸ **setSource**(`source`, `options?`): `Promise`\<[`CameraKitSource`](CameraKitSource.md)\>
+#### Call Signature
 
-#### Parameters
+> **setSource**(`source`, `options`?): `Promise`\<[`CameraKitSource`](CameraKitSource.md)\>
 
-| Name | Type |
-| :------ | :------ |
-| `source` | `HTMLVideoElement` \| `MediaStream` |
-| `options?` | `Partial`\<[`CameraKitDeviceOptions`](../interfaces/CameraKitDeviceOptions.md)\> |
+Set the media source for this session.
 
-#### Returns
+Sessions may only have one source at a time - if `setSource` is called multiple times, subsequent calls replace
+the prior source. Setting the source does not trigger rendering (that’s done by `session.play()`). If the session
+is already playing, setting the source will immediately begin rendering the new source.
+
+The CameraKit SDK provides implementations for various common sources, which applications can create using the
+following functions:
+- [createMediaStreamSource](../functions/createMediaStreamSource.md)
+- [createVideoSource](../functions/createVideoSource.md)
+- [createImageSource](../functions/createImageSource.md)
+
+**Important:** Once a source has been set for a session, it cannot be set again, even if it has been replaced
+by another one. You must provide a new instance of [CameraKitSource](CameraKitSource.md) to [CameraKitSession.setSource](CameraKitSession.md#setsource).
+If you want to reuse the existing source, you can use its [CameraKitSource.copy](CameraKitSource.md#copy) method to create a new
+instance.
+
+##### Parameters
+
+###### source
+
+A CameraKitSource object representing input media (e.g. a webcam stream, video, or some other
+source of image data), which CameraKit will supply to Lenses in order for them to render effects on top of that
+source.
+
+`HTMLVideoElement` | `MediaStream`
+
+###### options?
+
+`Partial`\<[`CameraKitDeviceOptions`](../interfaces/CameraKitDeviceOptions.md)\>
+
+##### Returns
 
 `Promise`\<[`CameraKitSource`](CameraKitSource.md)\>
 
-___
+Promise is resolved when the source has successfully been set. If the session was already in the playing
+state, the Promise resolves when the first frame from the new source has been rendered. The resolved value is
+the [CameraKitSource](CameraKitSource.md) object attached to the session.
 
-### setFPSLimit
+***
 
-▸ **setFPSLimit**(`fpsLimit`): `Promise`\<`void`\>
+### setFPSLimit()
+
+> **setFPSLimit**(`fpsLimit`): `Promise`\<`void`\>
 
 Set an FPS limit.
 
@@ -345,9 +385,11 @@ alternatives.
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `fpsLimit` | `number` | A maximum FPS, rendering will not exceed this limit |
+##### fpsLimit
+
+`number`
+
+A maximum FPS, rendering will not exceed this limit
 
 #### Returns
 
@@ -355,11 +397,11 @@ alternatives.
 
 Promise is resolved when the limit is successfully set.
 
-___
+***
 
-### destroy
+### destroy()
 
-▸ **destroy**(): `Promise`\<`void`\>
+> **destroy**(): `Promise`\<`void`\>
 
 Destroy the session.
 

package/docs/md/classes/CameraKitSource.md

@@ -1,4 +1,8 @@
-[CameraKit Web SDK - v1.0.1](../README.md) / [Exports](../modules.md) / CameraKitSource
+[**CameraKit Web SDK v1.2.0**](../README.md)
+
+***
+
+[CameraKit Web SDK](../globals.md) / CameraKitSource
 
 # Class: CameraKitSource
 
@@ -15,31 +19,25 @@ even if it has been detached. You must supply a new instance of [CameraKitSource
 If you want to reuse the existing source, you can use its [CameraKitSource.copy](CameraKitSource.md#copy) method to create a new
 instance.
 
-## Table of contents
+## Constructors
 
-### Constructors
+### new CameraKitSource()
 
-- [constructor](CameraKitSource.md#constructor)
+> **new CameraKitSource**(`sourceInfo`, `subscriber`, `deviceInfo`): [`CameraKitSource`](CameraKitSource.md)
 
-### Methods
+#### Parameters
 
-- [copy](CameraKitSource.md#copy)
-- [setRenderSize](CameraKitSource.md#setrendersize)
-- [setTransform](CameraKitSource.md#settransform)
+##### sourceInfo
 
-## Constructors
+[`CameraKitSourceInfo`](../interfaces/CameraKitSourceInfo.md)
 
-### constructor
+##### subscriber
 
-• **new CameraKitSource**(`sourceInfo`, `subscriber?`, `deviceInfo?`): [`CameraKitSource`](CameraKitSource.md)
+[`CameraKitSourceSubscriber`](../interfaces/CameraKitSourceSubscriber.md) = `{}`
 
-#### Parameters
+##### deviceInfo
 
-| Name | Type |
-| :------ | :------ |
-| `sourceInfo` | [`CameraKitSourceInfo`](../interfaces/CameraKitSourceInfo.md) |
-| `subscriber` | [`CameraKitSourceSubscriber`](../interfaces/CameraKitSourceSubscriber.md) |
-| `deviceInfo` | `Partial`\<[`CameraKitDeviceOptions`](../interfaces/CameraKitDeviceOptions.md)\> |
+`Partial`\<[`CameraKitDeviceOptions`](../interfaces/CameraKitDeviceOptions.md)\> = `{}`
 
 #### Returns
 
@@ -47,17 +45,19 @@ instance.
 
 ## Methods
 
-### copy
+### copy()
 
-▸ **copy**(`deviceInfo?`): [`CameraKitSource`](CameraKitSource.md)
+> **copy**(`deviceInfo`): [`CameraKitSource`](CameraKitSource.md)
 
 Make a copy of the source, sharing the same [CameraKitSourceSubscriber](../interfaces/CameraKitSourceSubscriber.md).
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `deviceInfo` | `Partial`\<[`CameraKitDeviceOptions`](../interfaces/CameraKitDeviceOptions.md)\> | Optionally provide new device info for the copy (e.g. to change the camera type). |
+##### deviceInfo
+
+`Partial`\<[`CameraKitDeviceOptions`](../interfaces/CameraKitDeviceOptions.md)\> = `{}`
+
+Optionally provide new device info for the copy (e.g. to change the camera type).
 
 #### Returns
 
@@ -65,11 +65,11 @@ Make a copy of the source, sharing the same [CameraKitSourceSubscriber](../inter
 
 The new [CameraKitSource](CameraKitSource.md)
 
-___
+***
 
-### setRenderSize
+### setRenderSize()
 
-▸ **setRenderSize**(`width`, `height`): `Promise`\<`void`\>
+> **setRenderSize**(`width`, `height`): `Promise`\<`void`\>
 
 Set the resolution used to render this source.
 
@@ -86,14 +86,21 @@ on a web page is determined by the CSS of the page. It is distinct from the size
 Lenses. Performance is dominated by render size, while any display scaling (using CSS) can most often be thought
 of as free.
 
-The size of the Live and Capture [RenderTarget](../modules.md#rendertarget) is always the same.
+The size of the Live and Capture [RenderTarget](../type-aliases/RenderTarget.md) is always the same.
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `width` | `number` | pixels |
-| `height` | `number` | pixels |
+##### width
+
+`number`
+
+pixels
+
+##### height
+
+`number`
+
+pixels
 
 #### Returns
 
@@ -101,24 +108,26 @@ The size of the Live and Capture [RenderTarget](../modules.md#rendertarget) is a
 
 Promise resolves when the render size has been successfully updated.
 
-**`Todo`**
+#### Todo
 
 Currently it's only valid to call `setRenderSize` after `CameraKitSession.play` has been called. This
 constraint should be removed, so callers don't have to understand the underlying LensCore state machine.
 
-___
+***
 
-### setTransform
+### setTransform()
 
-▸ **setTransform**(`transform`): `Promise`\<`void`\>
+> **setTransform**(`transform`): `Promise`\<`void`\>
 
 Apply a 2D transformation to the source (e.g. translation, rotation, scale).
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `transform` | [`Transform2D`](Transform2D.md) | Specifies the 3x3 matrix describing the transformation. |
+##### transform
+
+[`Transform2D`](Transform2D.md)
+
+Specifies the 3x3 matrix describing the transformation.
 
 #### Returns