Show / Hide Table of Contents

    Class ScreenRecorderBuilder

    Builder for creating an instance of IScreenRecorder for Video or Gif.

    Inheritance
    System.Object
    ScreenRecorderBuilder
    Namespace: VoxelBusters.ScreenRecorderKit
    Assembly: cs.temp.dll.dll
    Syntax
    public class ScreenRecorderBuilder

    Methods

    Build()

    Declaration
    public IScreenRecorder Build()
    Returns
    Type Description
    IScreenRecorder

    CreateGifRecorder(Camera, GifRecorderSettings)

    Creates an instance of GIF recorder.

    Declaration
    public static ScreenRecorderBuilder CreateGifRecorder(Camera camera = null, GifRecorderSettings settings = null)
    Parameters
    Type Name Description
    Camera camera

    Camera which needs to be recorded. If null, whole screen will be recorded.

    GifRecorderSettings settings

    Settings for configuring this gif recorder.

    Returns
    Type Description
    ScreenRecorderBuilder

    CreateVideoRecorder(VideoRecorderRuntimeSettings)

    Creates an instance of the video recorder.

    Declaration
    public static ScreenRecorderBuilder CreateVideoRecorder(VideoRecorderRuntimeSettings runtimeSettings = null)
    Parameters
    Type Name Description
    VideoRecorderRuntimeSettings runtimeSettings

    Runtime configurable properties.

    Returns
    Type Description
    ScreenRecorderBuilder

    CreateVideoRecorder(VideoRecorderRuntimeSettingsOption[])

    Creates an instance of the video recorder.

    Declaration
    public static ScreenRecorderBuilder CreateVideoRecorder(params VideoRecorderRuntimeSettingsOption[] runtimeSettingsOptions)
    Parameters
    Type Name Description
    VoxelBusters.ScreenRecorderKit.VideoRecorderRuntimeSettingsOption[] runtimeSettingsOptions

    Runtime configurable properties.

    Returns
    Type Description
    ScreenRecorderBuilder

    CreateVideoRecorder(VideoRecorderSettings, VideoRecorderRuntimeSettings)

    Creates an instance of the video recorder.

    Declaration
    public static ScreenRecorderBuilder CreateVideoRecorder(VideoRecorderSettings settings = null, VideoRecorderRuntimeSettings runtimeSettings = null)
    Parameters
    Type Name Description
    VoxelBusters.ScreenRecorderKit.VideoRecorderSettings settings

    Basic settings properties.

    VideoRecorderRuntimeSettings runtimeSettings

    Runtime configurable properties.

    Returns
    Type Description
    ScreenRecorderBuilder

    CreateVideoRecorder(VideoRecorderSettings, VideoRecorderRuntimeSettingsOption[])

    Creates an instance of the video recorder.

    Declaration
    public static ScreenRecorderBuilder CreateVideoRecorder(VideoRecorderSettings settings = null, params VideoRecorderRuntimeSettingsOption[] runtimeSettingsOptions)
    Parameters
    Type Name Description
    VoxelBusters.ScreenRecorderKit.VideoRecorderSettings settings

    Basic settings properties.

    VoxelBusters.ScreenRecorderKit.VideoRecorderRuntimeSettingsOption[] runtimeSettingsOptions

    Runtime configurable properties.

    Returns
    Type Description
    ScreenRecorderBuilder

    SetOnRecordingAvailable(SuccessCallback<ScreenRecorderRecordingAvailableResult>)

    Declaration
    public ScreenRecorderBuilder SetOnRecordingAvailable(SuccessCallback<ScreenRecorderRecordingAvailableResult> callback = null)
    Parameters
    Type Name Description
    SuccessCallback<VoxelBusters.ScreenRecorderKit.ScreenRecorderRecordingAvailableResult> callback
    Returns
    Type Description
    ScreenRecorderBuilder
    Back to top Copyright © 2022 Voxel Busters Interactive LLP.