@pexip/media-control 20.3.4 → 20.3.5

package/api-docs/type-aliases/Events.mdx

@@ -0,0 +1,51 @@
+```ts
+type Events = 
+  | {
+  id: string;
+  type: Mute;
+}
+  | {
+  id: string;
+  type: Unmute;
+}
+  | {
+  id: string;
+  type: Ended;
+}
+  | {
+  devices: MediaDeviceInfoLike[];
+  type: DevicesChanged;
+}
+  | {
+  devices: MediaDeviceInfoLike[];
+  devicesFound: MediaDeviceInfoLike[];
+  type: DevicesFound;
+}
+  | {
+  devices: MediaDeviceInfoLike[];
+  devicesLost: MediaDeviceInfoLike[];
+  type: DevicesLost;
+}
+  | {
+  devices: MediaDeviceInfoLike[];
+  type: NoInputDevices;
+}
+  | {
+  device: MediaDeviceInfoLike;
+  type: DeviceLost;
+}
+  | {
+  error: Error;
+  type: Error;
+}
+  | {
+  facingMode: boolean;
+  stream: MediaStream;
+  type: Stream;
+  video: boolean;
+};
+```
+
+**`Beta`**
+
+Event object by MediaEventType

package/api-docs/type-aliases/FacingMode.mdx

@@ -0,0 +1,3 @@
+```ts
+type FacingMode = typeof FACING_MODE[number];
+```

package/api-docs/type-aliases/IncludeExcludeConstraint.mdx

@@ -0,0 +1,3 @@
+```ts
+type IncludeExcludeConstraint = ExtractObjectValueTypes<typeof INCLUDE_EXCLUDE_CONSTRAINT>;
+```

package/api-docs/type-aliases/InputDeviceConstraint.mdx

@@ -0,0 +1,6 @@
+```ts
+type InputDeviceConstraint = 
+  | DeviceConstraint
+  | InputConstraintSet
+  | boolean;
+```

package/api-docs/type-aliases/MediaDeviceInfoLike.mdx

@@ -0,0 +1,13 @@
+```ts
+type MediaDeviceInfoLike = Omit<MediaDeviceInfo, "toJSON"> & object;
+```
+
+**`Beta`**
+
+A striped version of MediaDeviceInfo
+
+## Type Declaration
+
+| Name | Type |
+| ------ | ------ |
+| `toJSON?` | `MediaDeviceInfo`\[`"toJSON"`\] |

package/api-docs/type-aliases/MediaEvent.mdx

@@ -0,0 +1,7 @@
+```ts
+type MediaEvent = CustomEvent<Events>;
+```
+
+**`Beta`**
+
+Custom Media Event

package/api-docs/type-aliases/MediaStreamTrackLike.mdx

@@ -0,0 +1,7 @@
+```ts
+type MediaStreamTrackLike = Pick<MediaStreamTrack, "id" | "kind" | "label" | "getSettings" | "stop">;
+```
+
+**`Beta`**
+
+Lesser strict type of `MediaStreamTrack`

package/api-docs/type-aliases/Unsubscribe.mdx

@@ -0,0 +1,7 @@
+```ts
+type Unsubscribe = () => void;
+```
+
+## Returns
+
+`void`

package/api-docs/variables/CURSOR_CAPTURE_CONSTRAINT.mdx

@@ -0,0 +1,18 @@
+```ts
+const CURSOR_CAPTURE_CONSTRAINT: object;
+```
+
+The `CursorCaptureConstraint` enumerates the conditions under which the
+cursor is captured.
+
+## Type Declaration
+
+| Name | Type | Default value |
+| ------ | ------ | ------ |
+| <a id="never"></a> `Never` | `"never"` | `'never'` |
+| <a id="always"></a> `Always` | `"always"` | `'always'` |
+| <a id="motion"></a> `Motion` | `"motion"` | `'motion'` |
+
+## See
+
+[https://w3c.github.io/mediacapture-screen-share/#cursorcaptureconstraint](https://w3c.github.io/mediacapture-screen-share/#cursorcaptureconstraint)

package/api-docs/variables/DEVICE_ID_SEPARATOR.mdx

@@ -0,0 +1,3 @@
+```ts
+const DEVICE_ID_SEPARATOR: ":" = ':';
+```

package/api-docs/variables/DISPLAY_CAPTURE_SURFACE_TYPE.mdx

@@ -0,0 +1,18 @@
+```ts
+const DISPLAY_CAPTURE_SURFACE_TYPE: object;
+```
+
+The `DisplayCaptureSurfaceType` enumeration describes the different types of
+display surface
+
+## Type Declaration
+
+| Name | Type | Default value |
+| ------ | ------ | ------ |
+| <a id="monitor"></a> `Monitor` | `"monitor"` | `'monitor'` |
+| <a id="window"></a> `Window` | `"window"` | `'window'` |
+| <a id="browser"></a> `Browser` | `"browser"` | `'browser'` |
+
+## See
+
+[https://w3c.github.io/mediacapture-screen-share/#displaycapturesurfacetype](https://w3c.github.io/mediacapture-screen-share/#displaycapturesurfacetype)

package/api-docs/variables/INCLUDE_EXCLUDE_CONSTRAINT.mdx

@@ -0,0 +1,10 @@
+```ts
+const INCLUDE_EXCLUDE_CONSTRAINT: object;
+```
+
+## Type Declaration
+
+| Name | Type | Default value |
+| ------ | ------ | ------ |
+| <a id="include"></a> `Include` | `"include"` | `'include'` |
+| <a id="exclude"></a> `Exclude` | `"exclude"` | `'exclude'` |

package/api-docs/variables/findAudioInputDevices.mdx

@@ -0,0 +1,19 @@
+```ts
+const findAudioInputDevices: (devices) => MediaDeviceInfoLike[];
+```
+
+**`Beta`**
+
+Find in the list of devices only the audio input ones
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `devices` | [`MediaDeviceInfoLike`](../type-aliases/MediaDeviceInfoLike.mdx)[] | A list of media devices from `navigator.mediaDevices.enumerateDevices()`. Will be used for search target |
+
+## Returns
+
+[`MediaDeviceInfoLike`](../type-aliases/MediaDeviceInfoLike.mdx)[]
+
+List of devices that are audio inputs

package/api-docs/variables/findAudioOutputDevices.mdx

@@ -0,0 +1,19 @@
+```ts
+const findAudioOutputDevices: (devices) => MediaDeviceInfoLike[];
+```
+
+**`Beta`**
+
+Find in the list of devices only the audio output ones
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `devices` | [`MediaDeviceInfoLike`](../type-aliases/MediaDeviceInfoLike.mdx)[] | A list of media devices from `navigator.mediaDevices.enumerateDevices()`. Will be used for search target |
+
+## Returns
+
+[`MediaDeviceInfoLike`](../type-aliases/MediaDeviceInfoLike.mdx)[]
+
+List of devices that are audio outputs

package/api-docs/variables/findVideoInputDevices.mdx

@@ -0,0 +1,19 @@
+```ts
+const findVideoInputDevices: (devices) => MediaDeviceInfoLike[];
+```
+
+**`Beta`**
+
+Find in the list of devices only the video input ones
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `devices` | [`MediaDeviceInfoLike`](../type-aliases/MediaDeviceInfoLike.mdx)[] | A list of media devices from `navigator.mediaDevices.enumerateDevices()`. Will be used for search target |
+
+## Returns
+
+[`MediaDeviceInfoLike`](../type-aliases/MediaDeviceInfoLike.mdx)[]
+
+List of devices that are video inputs

package/api-docs/variables/getUserMedia.mdx

@@ -0,0 +1,21 @@
+```ts
+getUserMedia: (__namedParameters) => Promise<MediaStream>;
+```
+
+Get MediaStream with provided [input constraints](../interfaces/MediaDeviceRequest.mdx)
+
+**`Beta`**
+
+Get MediaStream with MediaDeviceRequest
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `__namedParameters` | [`MediaDeviceRequest`](../interfaces/MediaDeviceRequest.mdx) |
+
+## Returns
+
+`Promise`\<`MediaStream`\>
+
+MediaStream

package/api-docs/variables/isAudioInput.mdx

@@ -0,0 +1,13 @@
+```ts
+const isAudioInput: (device) => boolean;
+```
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `device` | [`MediaDeviceInfoLike`](../type-aliases/MediaDeviceInfoLike.mdx) |
+
+## Returns
+
+`boolean`

package/api-docs/variables/isAudioOutput.mdx

@@ -0,0 +1,13 @@
+```ts
+const isAudioOutput: (device) => boolean;
+```
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `device` | [`MediaDeviceInfoLike`](../type-aliases/MediaDeviceInfoLike.mdx) |
+
+## Returns
+
+`boolean`

package/api-docs/variables/isVideoInput.mdx

@@ -0,0 +1,13 @@
+```ts
+const isVideoInput: (device) => boolean;
+```
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `device` | [`MediaDeviceInfoLike`](../type-aliases/MediaDeviceInfoLike.mdx) |
+
+## Returns
+
+`boolean`

package/api-docs/variables/setDefaultConstraints.mdx

@@ -0,0 +1,17 @@
+```ts
+setDefaultConstraints: (newConstraints) => void;
+```
+
+Set default media stream constraints
+
+A [MediaStreamConstraints](https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamConstraints) object specifying the types of media to request, along with any requirements for each type.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `newConstraints` | `MediaStreamConstraints` |
+
+## Returns
+
+`void`

package/api-docs/variables/subscribe.mdx

@@ -0,0 +1,25 @@
+```ts
+subscribe: (listener) => () => void;
+```
+
+Subscribe media events
+
+**`Beta`**
+
+Subscription media events
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `listener` | (`event`) => `void` |
+
+## Returns
+
+```ts
+(): void;
+```
+
+### Returns
+
+`void`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pexip/media-control",
-  "version": "20.3.4",
+  "version": "20.3.5",
   "homepage": "https://gitlab.com/pexip/zoo",
   "bugs": "https://gitlab.com/pexip/zoo/issues",
   "repository": {
@@ -27,27 +27,32 @@
       "import": "./dist/*.js"
     }
   },
+  "directories": {
+    "doc": "api-docs"
+  },
   "files": [
-    "dist"
+    "dist",
+    "api-docs"
   ],
   "scripts": {
-    "build": "pexip-bundler build",
-    "build:sourcemap": "pexip-bundler build --sourcemap",
-    "clean": "rm -rf dist",
+    "build": "pexip-bundler build && yarn docs",
+    "build:sourcemap": "pexip-bundler build --sourcemap && yarn docs",
+    "clean": "rm -rf dist api-docs",
     "dev": "pexip-bundler dev",
     "prepack": "yarn clean && yarn build",
     "test": "jest",
     "check-format": "prettier --ignore-path=../../.prettierignore --check .",
     "format": "prettier --ignore-path=../../.prettierignore --write .",
     "lint": "yarn run -T biome lint",
-    "typecheck": "yarn tsc --noEmit -p tsconfig.build.json"
+    "typecheck": "yarn tsc --noEmit -p tsconfig.build.json",
+    "docs": "typedoc"
   },
   "dependencies": {
-    "@pexip/utils": "17.1.2"
+    "@pexip/utils": "17.1.3"
   },
   "devDependencies": {
     "@jest/globals": "^30.2.0",
-    "@pexip/bundler": "18.1.2",
+    "@pexip/bundler": "18.2.0",
     "@swc/core": "^1.10.12",
     "@swc/jest": "^0.2.39",
     "@types/uuid": "^8.3.0",
@@ -55,6 +60,8 @@
     "jest": "^29.5.12",
     "jest-junit": "^16.0.0",
     "prettier": "^3.2.5",
+    "typedoc": "^0.28.15",
+    "typedoc-plugin-markdown": "^4.9.0",
     "typescript": "~5.7.3",
     "uuid": "^11.0.0"
   },