Class ClipID

Hierarchy

HandleWrapper
- ClipID

Index

Properties

Accessors

clipName customAttrs customAttrsCount file sequence

Methods

_checkHandle asDict asJson getCustomAttr hasCustomAttr removeCustomAttr setCustomAttr toJSON validate

Properties

`Protected`_addon

_addon: NativeAddon

Cached addon reference.

`Protected`_docRef

_docRef: OwnedHandle | null

Strong reference to the owning document. Prevents GC of the document while this child handle lives. For OwnedHandle, this is this (self-referencing).

Accessors

clipName

get clipName(): string
clipName

Returns string
- Defined in src/clip-id.ts:30

customAttrs

get customAttrs(): Record<string, CustomAttrValue>
Returns Record<string, CustomAttrValue>
- Defined in src/clip-id.ts:111

customAttrsCount

get customAttrsCount(): number
Returns number
- Defined in src/clip-id.ts:106

file

get file(): string | null
file

Returns string | null
- Defined in src/clip-id.ts:37

sequence

get sequence(): FileSequence | null
sequence

Returns FileSequence | null
- Defined in src/clip-id.ts:45

Methods

`Protected`_checkHandle

_checkHandle(): void
Check that the handle is still valid. Throws if closed.

Returns void
Inherited from HandleWrapper._checkHandle
- Defined in src/base.ts:59

asDict

asDict(): Record<string, unknown>
Returns Record<string, unknown>
- Defined in src/clip-id.ts:53

asJson

asJson(indent?: number): string
Parameters
- indent: number = 0
Returns string
- Defined in src/clip-id.ts:60

getCustomAttr

getCustomAttr(name: string): CustomAttrValue | null
Parameters
- name: string
Returns CustomAttrValue | null
- Defined in src/clip-id.ts:91

hasCustomAttr

hasCustomAttr(name: string): boolean
Parameters
- name: string
Returns boolean
- Defined in src/clip-id.ts:96

removeCustomAttr

removeCustomAttr(name: string): boolean
Parameters
- name: string
Returns boolean
- Defined in src/clip-id.ts:101

setCustomAttr

setCustomAttr(name: string, value: CustomAttrValue): void
Parameters
- name: string
- value: CustomAttrValue
Returns void
- Defined in src/clip-id.ts:86

toJSON

toJSON(): Record<string, unknown>
Returns Record<string, unknown>
- Defined in src/clip-id.ts:67

validate

validate(): void
Returns void
- Defined in src/clip-id.ts:71