AudioInput | References | ArcGIS Maps SDK for JavaScript

import AudioInput from "@arcgis/core/form/elements/inputs/attachments/AudioInput.js";

const AudioInput = await $arcgis.import("@arcgis/core/form/elements/inputs/attachments/AudioInput.js");

Inheritance: AudioInput→Input→Accessor

Since: ArcGIS Maps SDK for JavaScript 5.1

The AudioInput class defines a user interface for an input to which audio files can be attached.

Input methods that are configured as only allowing capture are not supported.
Minimum input requirements apply only in mobile editing workflows when the input method is set to only allow capture and the minimum file count is greater than or equal to one.
When using specific input types, such as AudioInput, existing attachments are displayed only if they match the element's keyword. Existing attachments without a matching keyword are not shown. To display attachments that do not have a corresponding keyword, use the general AttachmentInput instead. This input type provides a more general approach to displaying attachments and does not require a keyword to be specified by setting the attachmentAssociationType accordingly.

See also

AudioInput

Example

// Creates a new AudioInput for an attachment element within a form
const audioInput = new AudioInput({
  inputMethod: "capture",
  maxDuration: 30
});

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	AudioInputProperties

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
declaredClass readonly inherited	string	Accessor
inputMethod	InputMethod
maxDuration	number \| null \| undefined
type readonly	"audio"

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

Since: ArcGIS Maps SDK for JavaScript 4.7

The name of the class. The declared class name is formatted as esri.folder.className.

inputMethod

Property

Type: InputMethod

The supported input methods used to attach an audio file.

Default value: "any"

maxDuration

Property

Type: number | null | undefined

Defines the maximum length of an attachment for this element in seconds. If not specified, there is no maximum length.

type

readonly Property

Type: "audio"

The input type identifier.

Methods

Method	Signature	Class
fromJSON inherited static	fromJSON(json: any): any	JSONSupportMixin
clone inherited	clone(): this	ClonableMixin
toJSON inherited	toJSON(): any	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameters

Parameter	Type	Description	Required
json	any	A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns: any
Returns a new instance of this class.

clone

inherited Method

Signature: clone (): this

Inherited from: ClonableMixin

Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.

Returns: this
A deep clone of the class instance that invoked this method.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns: any
The ArcGIS portal JSON representation of an instance of this class.