AudioBlock

Defined in: src/types/media.ts:162

Audio content block.

Implements

• AudioBlockData
• JSONSerializable<{ audio: Serialized<AudioBlockData>; }>

Constructors

Constructor

new AudioBlock(data): AudioBlock;

Defined in: src/types/media.ts:172

Parameters

Parameter	Type
data	AudioBlockData

Returns

AudioBlock

Properties

type

readonly type: "audioBlock";

Defined in: src/types/media.ts:164

Discriminator for audio content.

---

format

readonly format: AudioFormat;

Defined in: src/types/media.ts:167

Audio format.

Implementation of

AudioBlockData.format

---

source

readonly source: AudioSource;

Defined in: src/types/media.ts:170

Audio source.

Implementation of

AudioBlockData.source

Methods

toJSON()

toJSON(): {
  audio: {
     format: AudioFormat;
     source:   | {
        bytes: string;
      }
        | {
        location: {
           type: "s3";
           uri: string;
           bucketOwner?: string;
        };
      };
  };
};

Defined in: src/types/media.ts:200

Serializes the AudioBlock to a JSON-compatible ContentBlockData object. Called automatically by JSON.stringify(). Uint8Array bytes are encoded as a base64 string.

Returns

{
  audio: {
     format: AudioFormat;
     source:   | {
        bytes: string;
      }
        | {
        location: {
           type: "s3";
           uri: string;
           bucketOwner?: string;
        };
      };
  };
}

Wrapped audio block data

Name	Type	Description	Defined in
audio	{ format: AudioFormat; source: | { bytes: string; } | { location: { type: "s3"; uri: string; bucketOwner?: string; }; }; }	-	src/types/media.ts:200
audio.format	AudioFormat	Audio format.	src/types/media.ts:153
audio.source	| { bytes: string; } | { location: { type: "s3"; uri: string; bucketOwner?: string; }; }	Audio source.	src/types/media.ts:156

Implementation of

JSONSerializable.toJSON

---

fromJSON()

static fromJSON(data): AudioBlock;

Defined in: src/types/media.ts:221

Creates an AudioBlock instance from its wrapped data format. Base64-encoded bytes are decoded back to Uint8Array.

Parameters

Parameter	Type	Description
data	{ audio: { format: AudioFormat; source: | { bytes: string | Uint8Array<ArrayBufferLike>; } | { location: { type: "s3"; uri: string; bucketOwner?: string; }; }; }; }	Wrapped AudioBlockData to deserialize
data.audio	{ format: AudioFormat; source: | { bytes: string | Uint8Array<ArrayBufferLike>; } | { location: { type: "s3"; uri: string; bucketOwner?: string; }; }; }	-
data.audio.format	AudioFormat	Audio format.
data.audio.source	| { bytes: string | Uint8Array<ArrayBufferLike>; } | { location: { type: "s3"; uri: string; bucketOwner?: string; }; }	Audio source.

Returns

AudioBlock

AudioBlock instance