Class AutoConvertRule

Undocumented

Hierarchy (view full)

SharedObservable
- AutoConvertRule

Constructors

constructor

new AutoConvertRule(): AutoConvertRule
Returns AutoConvertRule
Inherited from SharedObservable.constructor

Properties

asJSON

asJSON: string

Gets the object as serialized JSON string. Or sets serialized JSON (to fill this object's metadata by the metadata included within the JSON)

bitrate

bitrate: number

Undocumented

bitrateFrom

bitrateFrom: number

Undocumented

bitrateTo

bitrateTo: number

Undocumented

bps

bps: number

Undocumented

bpsFrom

bpsFrom: number

Undocumented

bpsTo

bpsTo: number

Undocumented

channels

channels: number

Undocumented

channelsFrom

channelsFrom: number

Undocumented

channelsTo

channelsTo: number

Undocumented

deleted

deleted: boolean

Set to true after deletion so that 'change' event is called and item is removed from UI lists.

dontNotify

dontNotify: boolean

Undocumented

frameRate

frameRate: number

Undocumented

frameRateFrom

frameRateFrom: number

Undocumented

frameRateTo

frameRateTo: number

Undocumented

height

height: number

Undocumented

heightFrom

heightFrom: number

Undocumented

heightTo

heightTo: number

Undocumented

id

id: number

Gets integer id of the object

isObservable

isObservable: boolean

Whether this object can be listened (e.g. for 'change' event)

isStatusBarSource

isStatusBarSource: boolean

Is source for status bar informations.

isVideo

isVideo: boolean

Undocumented

objectType

objectType: string

Gets the object type as string

persistentID

persistentID: string

Gets persistent id of the object

qualityProfile

qualityProfile: number

Undocumented

sampleRate

sampleRate: number

Undocumented

sampleRateFrom

sampleRateFrom: number

Undocumented

sampleRateTo

sampleRateTo: number

Undocumented

sourceFormat

sourceFormat: string

Undocumented

sourceFormatText

sourceFormatText: string

Undocumented

statusInfo

statusInfo: Promise<any>

Undocumented

targetFormat

targetFormat: string

Undocumented

targetFormatSettings

targetFormatSettings: GenFormatSettings

Undocumented

targetFormatText

targetFormatText: string

Undocumented

targetFormatTextLong

targetFormatTextLong: string

Undocumented

title

title: string

Gets the object title

vBitrate

vBitrate: number

Undocumented

vBitrateFrom

vBitrateFrom: number

Undocumented

vBitrateTo

vBitrateTo: number

Undocumented

width

width: number

Undocumented

widthFrom

widthFrom: number

Undocumented

widthTo

widthTo: number

Undocumented

Methods

beginUpdate

beginUpdate(): void
Lock object to update state. Events are not called when in update state.

Returns void
Inherited from SharedObservable.beginUpdate
- Defined in src/types/Native.ts:276

checkUpdate

checkUpdate(interval): void
Updates the object every X ms when called periodically. Useful e.g. when filling lists. Can be used only in the update lock! (i.e. between beginUpdate/endUpdate)
Parameters
- interval: number
Returns void
Inherited from SharedObservable.checkUpdate
- Defined in src/types/Native.ts:288

doCut

doCut(data): Promise<any>
Parameters
- data: Base
Returns Promise<any>
Undocumented
Inherited from SharedObservable.doCut
- Defined in src/types/Native.ts:213

endUpdate

endUpdate(): boolean
Unlock object from update state. beginUpdate and endUpdate must be in pair. When endUpdate is called, change event is called.

Returns boolean
Inherited from SharedObservable.endUpdate
- Defined in src/types/Native.ts:282

getClassName

getClassName(): string
Gets class name of the object.

Returns string
Inherited from SharedObservable.getClassName
- Defined in src/types/Native.ts:198

getCopy

getCopy(): AutoConvertRule
Returns AutoConvertRule
Undocumented
- Defined in src/types/Native.ts:4166

getPersistentJSON

getPersistentJSON(): string
Returns string
Undocumented
Inherited from SharedObservable.getPersistentJSON
- Defined in src/types/Native.ts:214

getTargetFormatList

getTargetFormatList(aIsVideo, convertSettings): FormatSettingsList
Parameters
- aIsVideo: boolean
- convertSettings: SharedObject
Returns FormatSettingsList
Undocumented
- Defined in src/types/Native.ts:4137

isMarked

isMarked(id): boolean
Parameters
- id: number
Returns boolean
Undocumented
Inherited from SharedObservable.isMarked
- Defined in src/types/Native.ts:212

loadFrom

loadFrom(rule): void
Parameters
- rule: AutoConvertRule
Returns void
Undocumented
- Defined in src/types/Native.ts:4165

locked

locked(func): void
Call defined method with locked data so user can access them.
Parameters
- func: (() => any)
  Method to call
  - - (): any
    - Returns any
Returns void
Inherited from SharedObservable.locked
- Defined in src/types/Native.ts:192

modifyAsync

modifyAsync(...params): Promise<any>
Call defined method with the item locked for modifications.
Parameters
- Rest ...params: any[]
Returns Promise<any>
Inherited from SharedObservable.modifyAsync
- Defined in src/types/Native.ts:262

notifyChanged

notifyChanged(...params): void
Notifies that the object was changed (e.g. to force visual update etc.)
Parameters
- Rest ...params: any[]
Returns void
Inherited from SharedObservable.notifyChanged
- Defined in src/types/Native.ts:308

setMarked

setMarked(id, value): void
Parameters
- id: number
- value: boolean
Returns void
Undocumented
Inherited from SharedObservable.setMarked
- Defined in src/types/Native.ts:211

toString

toString(): string
Returns string
Undocumented
Inherited from SharedObservable.toString
- Defined in src/types/Native.ts:264

toUriString

toUriString(): string
Returns string
Undocumented
Inherited from SharedObservable.toUriString
- Defined in src/types/Native.ts:263

updateStatus

updateStatus(): void
Returns void
Undocumented
Inherited from SharedObservable.updateStatus
- Defined in src/types/Native.ts:297

Events

event_change

event_change: ((changeType, ...additionalArgs) => void)

Event is called when object is somehow changed

See App.listen

Type declaration

- (changeType, ...additionalArgs): void
- Parameters
  - changeType: string
    additional change type (can have values like 'tracklist', 'deleted', 'title' or undefined)
  - Rest ...additionalArgs: any[]
  Returns void

Example

app.listen(object, 'change', (changeType) => {  });

event_destroying

event_destroying: (() => void)

Event is called when object is going to destroy

See App.listen

Type declaration

- (): void
- Returns void

event_statuschange

event_statuschange: (() => void)

Event is called when status info of the object is changed

See App.listen

Type declaration

- (): void
- Returns void

Class AutoConvertRule

Undocumented

Hierarchy (view full)

Index

Constructors

Properties

Methods

Events

Constructors

constructor

Returns AutoConvertRule

Properties

asJSON

bitrate

Undocumented

bitrateFrom

Undocumented

bitrateTo

Undocumented

bps

Undocumented

bpsFrom

Undocumented

bpsTo

Undocumented

channels

Undocumented

channelsFrom

Undocumented

channelsTo

Undocumented

deleted

dontNotify

Undocumented

frameRate

Undocumented

frameRateFrom

Undocumented

frameRateTo

Undocumented

height

Undocumented

heightFrom

Undocumented

heightTo

Undocumented

id

isObservable

isStatusBarSource

isVideo

Undocumented

objectType

persistentID

qualityProfile

Undocumented

sampleRate

Undocumented

sampleRateFrom

Undocumented

sampleRateTo

Undocumented

sourceFormat

Undocumented

sourceFormatText

Undocumented

statusInfo

Undocumented

targetFormat

Undocumented

targetFormatSettings

Undocumented

targetFormatText

Undocumented

targetFormatTextLong

Undocumented

title

vBitrate

Undocumented

vBitrateFrom

Undocumented