Class Settings

Index

Constructors

Methods

getDecoderPreferredAcceleration getEncoderBitrate getEncoderBitrateMode getEncoderCodec getEncoderCrf getEncoderDeadline getEncoderForcedCodecRFCString getEncoderPerformanceMode getEncoderPreferredAcceleration getEncoderUseAlpha getEncoderUseWebCodecs getM3u8MaxResolution getRenderAudioUseWorker getRenderMaxQueueSize getRenderShowPreview getRenderThrottleFactor getSubtitlesAutoWrapOnResize getSubtitlesScaleOnResize getViewAutoLayoutOnResize serialize setDecoderPreferredAcceleration setEncoderBitrate setEncoderBitrateMode setEncoderCodec setEncoderCrf setEncoderDeadline setEncoderForcedCodecRFCString setEncoderPerformanceMode setEncoderPreferredAcceleration setEncoderUseAlpha setEncoderUseWebCodecs setM3u8MaxResolution setRenderAudioUseWorker setRenderMaxQueueSize setRenderShowPreview setRenderThrottleFactor setSubtitlesAutoWrapOnResize setSubtitlesScaleOnResize setViewAutoLayoutOnResize deserialize

Constructors

constructor

new Settings(): Settings
Returns Settings

Methods

getDecoderPreferredAcceleration

getDecoderPreferredAcceleration(): PreferredAcceleration
Returns PreferredAcceleration

getEncoderBitrate

getEncoderBitrate(): number
Returns number

getEncoderBitrateMode

getEncoderBitrateMode(): BitrateMode
Returns BitrateMode

getEncoderCodec

getEncoderCodec(): VideoCodec
Returns VideoCodec

getEncoderCrf

getEncoderCrf(): number
Returns number

getEncoderDeadline

getEncoderDeadline(): number
Returns number

getEncoderForcedCodecRFCString

getEncoderForcedCodecRFCString(): string
Returns string

getEncoderPerformanceMode

getEncoderPerformanceMode(): PerformanceMode
Returns PerformanceMode

getEncoderPreferredAcceleration

getEncoderPreferredAcceleration(): PreferredAcceleration
Returns PreferredAcceleration

getEncoderUseAlpha

getEncoderUseAlpha(): boolean
Returns boolean

getEncoderUseWebCodecs

getEncoderUseWebCodecs(): boolean
Returns boolean

getM3u8MaxResolution

getM3u8MaxResolution(): number[]
Returns number[]

getRenderAudioUseWorker

getRenderAudioUseWorker(): boolean
Returns boolean

getRenderMaxQueueSize

getRenderMaxQueueSize(): number
Returns number

getRenderShowPreview

getRenderShowPreview(): boolean
Returns boolean

getRenderThrottleFactor

getRenderThrottleFactor(): number
Returns number

getSubtitlesAutoWrapOnResize

getSubtitlesAutoWrapOnResize(): boolean
Returns boolean

getSubtitlesScaleOnResize

getSubtitlesScaleOnResize(): boolean
Returns boolean

getViewAutoLayoutOnResize

getViewAutoLayoutOnResize(): AutoLayoutMode
Returns AutoLayoutMode

serialize

serialize(): {
    decoderPreferredAcceleration: PreferredAcceleration;
    encoderBitrate: number;
    encoderBitrateMode: BitrateMode;
    encoderCodec: VideoCodec;
    encoderCrf: number;
    encoderDeadline: number;
    encoderForcedCodecRFCString: string;
    encoderPerformanceMode: PerformanceMode;
    encoderPreferredAcceleration: PreferredAcceleration;
    encoderUseAlpha: boolean;
    encoderUseWebCodecs: boolean;
    m3u8MaxResolution: [number, number];
    renderAudioUseWorker: boolean;
    renderMaxQueueSize: number;
    renderShowPreview: boolean;
    renderThrottleFactor: number;
    subtitlesAutoWrapOnResize: boolean;
    subtitlesScaleOnResize: boolean;
    viewAutoLayoutOnResize: AutoLayoutMode;
}
Returns {
    decoderPreferredAcceleration: PreferredAcceleration;
    encoderBitrate: number;
    encoderBitrateMode: BitrateMode;
    encoderCodec: VideoCodec;
    encoderCrf: number;
    encoderDeadline: number;
    encoderForcedCodecRFCString: string;
    encoderPerformanceMode: PerformanceMode;
    encoderPreferredAcceleration: PreferredAcceleration;
    encoderUseAlpha: boolean;
    encoderUseWebCodecs: boolean;
    m3u8MaxResolution: [number, number];
    renderAudioUseWorker: boolean;
    renderMaxQueueSize: number;
    renderShowPreview: boolean;
    renderThrottleFactor: number;
    subtitlesAutoWrapOnResize: boolean;
    subtitlesScaleOnResize: boolean;
    viewAutoLayoutOnResize: AutoLayoutMode;
}

setDecoderPreferredAcceleration

setDecoderPreferredAcceleration(acceleration: PreferredAcceleration): void
Parameters
- acceleration: PreferredAcceleration
Returns void

setEncoderBitrate

setEncoderBitrate(bitrate: number): void
Parameters
- bitrate: number
Returns void

setEncoderBitrateMode

setEncoderBitrateMode(mode: BitrateMode): void
Parameters
- mode: BitrateMode
Returns void

setEncoderCodec

setEncoderCodec(codec: VideoCodec): void
Parameters
- codec: VideoCodec
Returns void

setEncoderCrf

setEncoderCrf(crf: number): void
Parameters
- crf: number
Returns void

setEncoderDeadline

setEncoderDeadline(deadline: number): void
Parameters
- deadline: number
Returns void

setEncoderForcedCodecRFCString

setEncoderForcedCodecRFCString(codec: string): void
Parameters
- codec: string
Returns void

setEncoderPerformanceMode

setEncoderPerformanceMode(mode: PerformanceMode): void
Parameters
- mode: PerformanceMode
Returns void

setEncoderPreferredAcceleration

setEncoderPreferredAcceleration(acceleration: PreferredAcceleration): void
Parameters
- acceleration: PreferredAcceleration
Returns void

setEncoderUseAlpha

setEncoderUseAlpha(use: boolean): void
Parameters
- use: boolean
Returns void

setEncoderUseWebCodecs

setEncoderUseWebCodecs(use: boolean): void
Parameters
- use: boolean
Returns void

setM3u8MaxResolution

setM3u8MaxResolution(width: number, height: number): void
Parameters
- width: number
- height: number
Returns void

setRenderAudioUseWorker

setRenderAudioUseWorker(use: boolean): void
Parameters
- use: boolean
Returns void

setRenderMaxQueueSize

setRenderMaxQueueSize(size: number): void
Parameters
- size: number
Returns void

setRenderShowPreview

setRenderShowPreview(show: boolean): void
Parameters
- show: boolean
Returns void

setRenderThrottleFactor

setRenderThrottleFactor(factor: number): void
Parameters
- factor: number
Returns void

setSubtitlesAutoWrapOnResize

setSubtitlesAutoWrapOnResize(autoWrap: boolean): void
Parameters
- autoWrap: boolean
Returns void

setSubtitlesScaleOnResize

setSubtitlesScaleOnResize(scale: boolean): void
Parameters
- scale: boolean
Returns void

setViewAutoLayoutOnResize

setViewAutoLayoutOnResize(autoLayoutMode: AutoLayoutMode): void
Parameters
- autoLayoutMode: AutoLayoutMode
Returns void

`Static`deserialize

deserialize(data: object): Settings
Parameters
- data: object
Returns Settings