VideoBlock

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

Video content block.

Implements

• VideoBlockData
• JSONSerializable<{ video: Serialized<VideoBlockData>; }>

Constructors

Constructor

new VideoBlock(data): VideoBlock;

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

Parameters

Parameter	Type
data	VideoBlockData

Returns

VideoBlock

Properties

type

readonly type: "videoBlock";

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

Discriminator for video content.

---

format

readonly format: VideoFormat;

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

Video format.

Implementation of

VideoBlockData.format

---

source

readonly source: VideoSource;

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

Video source.

Implementation of

VideoBlockData.source

Methods

toJSON()

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

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

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

Returns

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

Name	Type	Description	Defined in
video	{ format: VideoFormat; source: | { bytes: string; } | { location: { type: "s3"; uri: string; bucketOwner?: string; }; }; }	-	src/types/media.ts:331
video.format	VideoFormat	Video format.	src/types/media.ts:281
video.source	| { bytes: string; } | { location: { type: "s3"; uri: string; bucketOwner?: string; }; }	Video source.	src/types/media.ts:286

Implementation of

JSONSerializable.toJSON

---

fromJSON()

static fromJSON(data): VideoBlock;

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

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

Parameters

Parameter	Type	Description
data	{ video: { format: VideoFormat; source: | { bytes: string | Uint8Array<ArrayBufferLike>; } | { location: { type: "s3"; uri: string; bucketOwner?: string; }; }; }; }	Wrapped VideoBlockData to deserialize (accepts both string and Uint8Array for bytes)
data.video	{ format: VideoFormat; source: | { bytes: string | Uint8Array<ArrayBufferLike>; } | { location: { type: "s3"; uri: string; bucketOwner?: string; }; }; }	-
data.video.format	VideoFormat	Video format.
data.video.source	| { bytes: string | Uint8Array<ArrayBufferLike>; } | { location: { type: "s3"; uri: string; bucketOwner?: string; }; }	Video source.

Returns

VideoBlock

VideoBlock instance