Skip to main content

Interface: SoundRecorderOptions

Extends​

Properties​

alpha?​

optional alpha: number

Opacity of the node. 0 is fully transparent, 1 is fully opaque. Default is 1.0. Alpha has multiplicative inheritance. For example, if the node's parent is alpha .5 and this node's is alpha .4, then the node will appear with alpha .2.

Inherited from​

M2NodeOptions.alpha

Defined in​

m2c2kit/packages/core/src/M2NodeOptions.ts:12

audioTrackConstraints?​

optional audioTrackConstraints: MediaTrackConstraints

Additional audio constraints to be applied when requesting the audio device. see https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackConstraints

Remarks​

Use with caution. All kinds of constraints may not be supported on all browsers, and specifying too restrictive constraints will result in no available user audio device and an exception. Unusual constraints may also result in an unexpected device being selected.

Example​

audioTrackConstraints: {
   channelCount: 1,
   noiseSuppression: { ideal: true },
 }

Defined in​

m2c2kit/packages/core/src/SoundRecorderOptions.ts:22

backupMimeTypes?​

optional backupMimeTypes: string[]

Additional MIME types to use for recording audio, in order of preference, if preferred type is not supported. ["audio/webm", "audio/mp4"] is recommended.

Defined in​

m2c2kit/packages/core/src/SoundRecorderOptions.ts:7

draggable?​

optional draggable: boolean

Can the node be dragged?

Inherited from​

M2NodeOptions.draggable

Defined in​

m2c2kit/packages/core/src/M2NodeOptions.ts:18

hidden?​

optional hidden: boolean

Is the node, and its children, hidden? (not displayed). Default is false

Inherited from​

M2NodeOptions.hidden

Defined in​

m2c2kit/packages/core/src/M2NodeOptions.ts:20

isPartOfComposite?​

optional isPartOfComposite: boolean

Is the node part of a composite? Default is false.

Remarks​

This property is for use by authors of Composite nodes. It is not intended for general use.

Inherited from​

M2NodeOptions.isPartOfComposite

Defined in​

m2c2kit/packages/core/src/M2NodeOptions.ts:27

isUserInteractionEnabled?​

optional isUserInteractionEnabled: boolean

Does the node respond to user events, such as taps? Default is false

Inherited from​

M2NodeOptions.isUserInteractionEnabled

Defined in​

m2c2kit/packages/core/src/M2NodeOptions.ts:16

layout?​

optional layout: Layout

FOR INTERNAL USE ONLY

Inherited from​

M2NodeOptions.layout

Defined in​

m2c2kit/packages/core/src/M2NodeOptions.ts:22

maximumDuration?​

optional maximumDuration: number

Maximum duration, in milliseconds, to allow recording. If recording lasts longer than this duration, it will automatically be paused. This can be used to prevent excessively long recording and memory usage.

Defined in​

m2c2kit/packages/core/src/SoundRecorderOptions.ts:9

mimeType?​

optional mimeType: string

Preferred MIME type to use for recording audio. audio/webm or audio/mp4 is recommended. If omitted, it will use any MIME type supported by the device.

Defined in​

m2c2kit/packages/core/src/SoundRecorderOptions.ts:5

name?​

optional name: string

Name of the node. Only needed if the node will be referred to by name in a later function

Inherited from​

M2NodeOptions.name

Defined in​

m2c2kit/packages/core/src/M2NodeOptions.ts:6

position?​

optional position: Point

Position of the node within its parent coordinate system. Default is (0, 0)

Inherited from​

M2NodeOptions.position

Defined in​

m2c2kit/packages/core/src/M2NodeOptions.ts:8

scale?​

optional scale: number

Scale of the node. Default is 1.0

Inherited from​

M2NodeOptions.scale

Defined in​

m2c2kit/packages/core/src/M2NodeOptions.ts:10

uuid?​

optional uuid: string

Internal

Unique identifier (UUID). Will be generated automatically. For m2c2kit library use only

Inherited from​

M2NodeOptions.uuid

Defined in​

m2c2kit/packages/core/src/M2NodeOptions.ts:24

zRotation?​

optional zRotation: number

Rotation of the node around the Z axis. Unit is radians. Default is 0 (no rotation). zRotation has inheritance. In addition to this node's zRotation, all ancestors' zRotations will be applied.

Inherited from​

M2NodeOptions.zRotation

Defined in​

m2c2kit/packages/core/src/M2NodeOptions.ts:14