@rendley/sdk - v1.15.5
    Preparing search index...

    Class Settings

    Stores project-wide runtime and export settings used by the engine, renderer, media pipeline, and subtitles.

    Index

    Constructors

    constructor

    Methods

    getClipAudioMonoChannelsWeight getClipAudioMonoMixType getClipAudioSampleForceMono getClipAudioSampleRate getClipAudioSeekThreshold getClipAudioStoreSamples getClipVideoDynamicLoad getClipVideoDynamicLoadTime getClipVideoFilmstripInterval getClipVideoFilmstripKeyframesOnly getClipVideoFilmstripMaxFrames getClipVideoFilmstripMaxHeight getClipVideoFilmstripMaxWidth getClipVideoFilmstripMaxWorkers getClipVideoSeekThreshold getClipVideoStoreFilmstrip getClipVideoStoreSamples getDecoderPreferredAcceleration getDecoderUseSeparateWorker getDecoderUseSubImage getDecoderUseWebCodecs getDefaultSettings getEncoderBitrate getEncoderBitrateMode getEncoderCodec getEncoderCrf getEncoderDeadline getEncoderForcedCodecRFCString getEncoderKeyframeInterval getEncoderPerformanceMode getEncoderPreferredAcceleration getEncoderUseAlpha getEncoderUseWebCodecs getM3u8MaxResolution getMediaHashAlgorithm getRenderAudioUseWorker getRenderCancelFailTimeout getRenderChunkedOutputMaxSize getRenderMaxQueueSize getRenderShowPreview getRenderThrottleFactor getRenderUseChunkedOutput getRenderVideoUseDirectFrames getSubtitlesAutoWrapOnResize getSubtitlesScaleOnResize getUseInternalTranscoder getViewAutoLayoutOnResize serialize setClipAudioMonoChannelsWeight setClipAudioMonoMixType setClipAudioSampleForceMono setClipAudioSampleRate setClipAudioSeekThreshold setClipAudioStoreSamples setClipVideoDynamicLoad setClipVideoDynamicLoadTime setClipVideoFilmstripInterval setClipVideoFilmstripKeyframesOnly setClipVideoFilmstripMaxFrames setClipVideoFilmstripMaxHeight setClipVideoFilmstripMaxWidth setClipVideoFilmstripMaxWorkers setClipVideoSeekThreshold setClipVideoStoreFilmstrip setClipVideoStoreSamples setDecoderPreferredAcceleration setDecoderUseSeparateWorker setDecoderUseSubImage setDecoderUseWebCodecs setEncoderBitrate setEncoderBitrateMode setEncoderCodec setEncoderCrf setEncoderDeadline setEncoderForcedCodecRFCString setEncoderKeyframeInterval setEncoderPerformanceMode setEncoderPreferredAcceleration setEncoderUseAlpha setEncoderUseWebCodecs setM3u8MaxResolution setMediaHashAlgorithm setRenderAudioUseWorker setRenderCancelFailTimeout setRenderChunkedOutputMaxSize setRenderMaxQueueSize setRenderShowPreview setRenderThrottleFactor setRenderUseChunkedOutput setRenderVideoUseDirectFrames setSubtitlesAutoWrapOnResize setSubtitlesScaleOnResize setUseInternalTranscoder setViewAutoLayoutOnResize deserialize

    Constructors

    • Creates a settings object initialized with SDK defaults.

      Returns Settings

    Methods

    • Returns number[]

    • Returns boolean

    • Returns number

    • Returns number

    • Returns boolean

    • Returns boolean

    • Returns number

    • Returns number

    • Returns boolean

    • Returns number

    • Returns number

    • Returns number

    • Returns number

    • Returns number

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Returns the immutable default settings payload derived from SettingsSchema.

      Returns {
          clipAudioMonoChannelsWeight: number[];
          clipAudioMonoMixType: MonoMixType;
          clipAudioSampleForceMono: boolean;
          clipAudioSampleRate: number;
          clipAudioSeekThreshold: number;
          clipAudioStoreSamples: boolean;
          clipVideoDynamicLoad: boolean;
          clipVideoDynamicLoadTime: number;
          clipVideoFilmstripInterval: number;
          clipVideoFilmstripKeyframesOnly: boolean;
          clipVideoFilmstripMaxFrames: number;
          clipVideoFilmstripMaxHeight: number;
          clipVideoFilmstripMaxWidth: number;
          clipVideoFilmstripMaxWorkers: number;
          clipVideoSeekThreshold: number;
          clipVideoStoreFilmstrip: boolean;
          clipVideoStoreSamples: boolean;
          decoderPreferredAcceleration: PreferredAcceleration;
          decoderUseSeparateWorker: boolean;
          decoderUseSubImage: boolean;
          decoderUseWebCodecs: boolean;
          encoderBitrate: number;
          encoderBitrateMode: BitrateMode;
          encoderCodec: VideoCodec;
          encoderCrf: number;
          encoderDeadline: number;
          encoderForcedCodecRFCString: string;
          encoderKeyframeInterval: number;
          encoderPerformanceMode: PerformanceMode;
          encoderPreferredAcceleration: PreferredAcceleration;
          encoderUseAlpha: boolean;
          encoderUseWebCodecs: boolean;
          m3u8MaxResolution: [number, number];
          mediaHashAlgorithm: HashAlgorithmEnum;
          renderAudioUseWorker: boolean;
          renderCancelFailTimeout: number;
          renderChunkedOutputMaxSize: number;
          renderMaxQueueSize: number;
          renderShowPreview: boolean;
          renderThrottleFactor: number;
          renderUseChunkedOutput: boolean;
          renderVideoUseDirectFrames: boolean;
          subtitlesAutoWrapOnResize: boolean;
          subtitlesScaleOnResize: boolean;
          useInternalTranscoder: boolean;
          viewAutoLayoutOnResize: AutoLayoutMode;
      }

      The default settings object.

    • Returns number

    • Returns number

    • Returns number

    • Returns string

    • Returns number

    • Returns boolean

    • Returns boolean

    • Returns number[]

    • Returns boolean

    • Returns number

    • Returns number

    • Returns number

    • Gets the visibility of the render preview.

      Returns boolean

      A boolean indicating whether the render preview is visible.

      • No longer used as there is no intermediate framebuffer

    • Returns number

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Serializes the current settings into a schema-validated plain object.

      Returns {
          clipAudioMonoChannelsWeight: number[];
          clipAudioMonoMixType: MonoMixType;
          clipAudioSampleForceMono: boolean;
          clipAudioSampleRate: number;
          clipAudioSeekThreshold: number;
          clipAudioStoreSamples: boolean;
          clipVideoDynamicLoad: boolean;
          clipVideoDynamicLoadTime: number;
          clipVideoFilmstripInterval: number;
          clipVideoFilmstripKeyframesOnly: boolean;
          clipVideoFilmstripMaxFrames: number;
          clipVideoFilmstripMaxHeight: number;
          clipVideoFilmstripMaxWidth: number;
          clipVideoFilmstripMaxWorkers: number;
          clipVideoSeekThreshold: number;
          clipVideoStoreFilmstrip: boolean;
          clipVideoStoreSamples: boolean;
          decoderPreferredAcceleration: PreferredAcceleration;
          decoderUseSeparateWorker: boolean;
          decoderUseSubImage: boolean;
          decoderUseWebCodecs: boolean;
          encoderBitrate: number;
          encoderBitrateMode: BitrateMode;
          encoderCodec: VideoCodec;
          encoderCrf: number;
          encoderDeadline: number;
          encoderForcedCodecRFCString: string;
          encoderKeyframeInterval: number;
          encoderPerformanceMode: PerformanceMode;
          encoderPreferredAcceleration: PreferredAcceleration;
          encoderUseAlpha: boolean;
          encoderUseWebCodecs: boolean;
          m3u8MaxResolution: [number, number];
          mediaHashAlgorithm: HashAlgorithmEnum;
          renderAudioUseWorker: boolean;
          renderCancelFailTimeout: number;
          renderChunkedOutputMaxSize: number;
          renderMaxQueueSize: number;
          renderShowPreview: boolean;
          renderThrottleFactor: number;
          renderUseChunkedOutput: boolean;
          renderVideoUseDirectFrames: boolean;
          subtitlesAutoWrapOnResize: boolean;
          subtitlesScaleOnResize: boolean;
          useInternalTranscoder: boolean;
          viewAutoLayoutOnResize: AutoLayoutMode;
      }

      The serialized settings payload.

    • Parameters

      • weights: number[]

      Returns void

    • Parameters

      • forceMono: boolean

      Returns void

    • Parameters

      • sampleRate: number

      Returns void

    • Parameters

      • threshold: number

      Returns void

    • Parameters

      • storeSamples: boolean

      Returns void

    • Parameters

      • enabled: boolean

      Returns void

    • Parameters

      • seconds: number

      Returns void

    • Parameters

      • interval: number

      Returns void

    • Parameters

      • keyframesOnly: boolean

      Returns void

    • Parameters

      • maxFrames: number

      Returns void

    • Parameters

      • maxHeight: number

      Returns void

    • Parameters

      • maxWidth: number

      Returns void

    • Parameters

      • maxWorkers: number

      Returns void

    • Parameters

      • threshold: number

      Returns void

    • Parameters

      • storeFilmstrip: boolean

      Returns void

    • Parameters

      • storeSamples: boolean

      Returns void

    • Parameters

      • use: boolean

      Returns void

    • Parameters

      • use: boolean

      Returns void

    • Parameters

      • use: boolean

      Returns void

    • Parameters

      • bitrate: number

      Returns void

    • Parameters

      • crf: number

      Returns void

    • Parameters

      • deadline: number

      Returns void

    • Parameters

      • codec: string

      Returns void

    • Parameters

      • interval: number

      Returns void

    • Parameters

      • use: boolean

      Returns void

    • Parameters

      • use: boolean

      Returns void

    • Parameters

      • width: number
      • height: number

      Returns void

    • Parameters

      • use: boolean

      Returns void

    • Parameters

      • timeout: number

      Returns void

    • Parameters

      • size: number

      Returns void

    • Parameters

      • size: number

      Returns void

    • Sets the visibility of the render preview.

      Parameters

      • show: boolean

        A boolean indicating whether to show the render preview.

      Returns void

      • No longer used as there is no intermediate framebuffer

    • Parameters

      • factor: number

      Returns void

    • Parameters

      • use: boolean

      Returns void

    • Parameters

      • use: boolean

      Returns void

    • Parameters

      • autoWrap: boolean

      Returns void

    • Parameters

      • scale: boolean

      Returns void

    • Parameters

      • use: boolean

      Returns void

    • Creates a settings instance from serialized data.

      Parameters

      • data: object

        Serialized settings payload to validate and load.

      Returns Settings

      The deserialized settings instance.

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    getClipAudioMonoChannelsWeightgetClipAudioMonoMixTypegetClipAudioSampleForceMonogetClipAudioSampleRategetClipAudioSeekThresholdgetClipAudioStoreSamplesgetClipVideoDynamicLoadgetClipVideoDynamicLoadTimegetClipVideoFilmstripIntervalgetClipVideoFilmstripKeyframesOnlygetClipVideoFilmstripMaxFramesgetClipVideoFilmstripMaxHeightgetClipVideoFilmstripMaxWidthgetClipVideoFilmstripMaxWorkersgetClipVideoSeekThresholdgetClipVideoStoreFilmstripgetClipVideoStoreSamplesgetDecoderPreferredAccelerationgetDecoderUseSeparateWorkergetDecoderUseSubImagegetDecoderUseWebCodecsgetDefaultSettingsgetEncoderBitrategetEncoderBitrateModegetEncoderCodecgetEncoderCrfgetEncoderDeadlinegetEncoderForcedCodecRFCStringgetEncoderKeyframeIntervalgetEncoderPerformanceModegetEncoderPreferredAccelerationgetEncoderUseAlphagetEncoderUseWebCodecsgetM3u8MaxResolutiongetMediaHashAlgorithmgetRenderAudioUseWorkergetRenderCancelFailTimeoutgetRenderChunkedOutputMaxSizegetRenderMaxQueueSizegetRenderShowPreviewgetRenderThrottleFactorgetRenderUseChunkedOutputgetRenderVideoUseDirectFramesgetSubtitlesAutoWrapOnResizegetSubtitlesScaleOnResizegetUseInternalTranscodergetViewAutoLayoutOnResizeserializesetClipAudioMonoChannelsWeightsetClipAudioMonoMixTypesetClipAudioSampleForceMonosetClipAudioSampleRatesetClipAudioSeekThresholdsetClipAudioStoreSamplessetClipVideoDynamicLoadsetClipVideoDynamicLoadTimesetClipVideoFilmstripIntervalsetClipVideoFilmstripKeyframesOnlysetClipVideoFilmstripMaxFramessetClipVideoFilmstripMaxHeightsetClipVideoFilmstripMaxWidthsetClipVideoFilmstripMaxWorkerssetClipVideoSeekThresholdsetClipVideoStoreFilmstripsetClipVideoStoreSamplessetDecoderPreferredAccelerationsetDecoderUseSeparateWorkersetDecoderUseSubImagesetDecoderUseWebCodecssetEncoderBitratesetEncoderBitrateModesetEncoderCodecsetEncoderCrfsetEncoderDeadlinesetEncoderForcedCodecRFCStringsetEncoderKeyframeIntervalsetEncoderPerformanceModesetEncoderPreferredAccelerationsetEncoderUseAlphasetEncoderUseWebCodecssetM3u8MaxResolutionsetMediaHashAlgorithmsetRenderAudioUseWorkersetRenderCancelFailTimeoutsetRenderChunkedOutputMaxSizesetRenderMaxQueueSizesetRenderShowPreviewsetRenderThrottleFactorsetRenderUseChunkedOutputsetRenderVideoUseDirectFramessetSubtitlesAutoWrapOnResizesetSubtitlesScaleOnResizesetUseInternalTranscodersetViewAutoLayoutOnResizedeserialize