Class StreamRecorderOptions

    Definition

    Namespace:
    Tizen.Multimedia
    Assembly:
    Tizen.Multimedia.StreamRecorder.dll

    Specifies the options associated with StreamRecorder.

    public class StreamRecorderOptions
    Inheritance
    object
    StreamRecorderOptions

    Constructors

    View Source

    StreamRecorderOptions(string, RecorderFileFormat)

    Initialize a new instance of the StreamRecorderOptions class with the specified save path and file format.

    Declaration
    public StreamRecorderOptions(string savePath, RecorderFileFormat fileFormat)
    Parameters
    Type Name Description
    string savePath

    The path that the recording result is saved.

    RecorderFileFormat fileFormat

    The file format of output file.

    Exceptions
    Type Condition
    System.ArgumentNullException

    savePathis null.

    System.ArgumentException

    savePathis an empty string.
    -or-
    fileFormat is not valid.

    See Also
    StreamRecorder
    Prepare(StreamRecorderOptions)
    StreamRecorderAudioOptions
    StreamRecorderVideoOptions

    Properties

    View Source

    Audio

    Gets or sets the options for audio recording.

    Declaration
    public StreamRecorderAudioOptions Audio { get; set; }
    Property Value
    Type Description
    StreamRecorderAudioOptions
    Remarks

    Audio or Video must be set for recording.

    See Also
    Video
    View Source

    FileFormat

    Gets or sets the file format for recording media stream.

    Declaration
    public RecorderFileFormat FileFormat { get; set; }
    Property Value
    Type Description
    RecorderFileFormat
    Exceptions
    Type Condition
    System.ArgumentException

    value is not valid.

    See Also
    GetSupportedFileFormats()
    View Source

    SavePath

    Gets or sets the file path to record.

    Declaration
    public string SavePath { get; set; }
    Property Value
    Type Description
    string
    Remarks

    If the same file already exists in the file system, then old file will be overwritten.

    Exceptions
    Type Condition
    System.ArgumentNullException

    valueis null.

    System.ArgumentException

    valueis an empty string.

    See Also
    StreamRecorder
    Prepare(StreamRecorderOptions)
    StreamRecorderAudioOptions
    StreamRecorderVideoOptions
    View Source

    SizeLimit

    Gets or sets the maximum size of a recording file.

    Declaration
    public int SizeLimit { get; set; }
    Property Value
    Type Description
    int

    The maximum size of a recording file in kilobytes, or 0 for unlimited size.

    Remarks

    After reaching the limitation, the data which is being recorded will be discarded and not written to the file.

    Exceptions
    Type Condition
    System.ArgumentOutOfRangeException

    value is less than zero.

    See Also
    RecordingLimitReached
    TimeLimit
    View Source

    TimeLimit

    Gets or sets the time limit of recording.

    Declaration
    public int TimeLimit { get; set; }
    Property Value
    Type Description
    int

    The maximum time of recording in seconds, or 0 for unlimited time.

    Remarks

    After reaching the limitation, the data which is being recorded will be discarded and not written to the file.

    Exceptions
    Type Condition
    System.ArgumentOutOfRangeException

    value is less than zero.

    See Also
    RecordingLimitReached
    SizeLimit
    View Source

    Video

    Gets or sets the options for video recording.

    Declaration
    public StreamRecorderVideoOptions Video { get; set; }
    Property Value
    Type Description
    StreamRecorderVideoOptions
    Remarks

    Audio or Video must be set for recording.

    See Also
    Audio

    See Also

    StreamRecorder
    Prepare(StreamRecorderOptions)
    StreamRecorderAudioOptions
    StreamRecorderVideoOptions
    • View Source
    Back to top Copyright © 2016-2024 Samsung
    Generated by DocFX