Class StreamRecorder

    Definition

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

    Provides the ability to record user buffer from application.

    public class StreamRecorder : IDisposable
    Inheritance
    object
    StreamRecorder
    Implements
    System.IDisposable

    Constructors

    View Source

    StreamRecorder()

    Initialize a new instance of the StreamRecorder class.

    Declaration
    public StreamRecorder()
    Exceptions
    Type Condition
    System.NotSupportedException

    The feature is not supported.

    See Also
    Recorder

    Properties

    View Source

    State

    Gets the current state of the stream recorder.

    Declaration
    public RecorderState State { get; }
    Property Value
    Type Description
    RecorderState
    Exceptions
    Type Condition
    System.ObjectDisposedException

    The StreamRecorder has already been disposed.

    See Also
    Recorder

    Methods

    View Source

    Cancel()

    Cancels recording. The recording data is discarded and not written.

    Declaration
    public void Cancel()
    Remarks

    The recorder state must be Recording state by Start() or Paused state by Pause().

    Exceptions
    Type Condition
    System.InvalidOperationException

    The recorder is not in the valid state.

    System.ObjectDisposedException

    The StreamRecorder has already been disposed.

    See Also
    Start()
    Pause()
    View Source

    Commit()

    Stops recording and saves the result.

    Declaration
    public void Commit()
    Remarks

    The recorder state must be Recording state by Start() or Paused state by Pause().

    The recorder state will be Ready after commit.

    http://tizen.org/privilege/mediastorage is needed if the save path are relevant to media storage. http://tizen.org/privilege/externalstorage is needed if the save path are relevant to external storage.

    Exceptions
    Type Condition
    System.InvalidOperationException

    The recorder is not in the valid state.

    System.UnauthorizedAccessException

    The access to the resources can not be granted.

    System.ObjectDisposedException

    The StreamRecorder has already been disposed.

    See Also
    Start()
    Pause()
    View Source

    Dispose()

    Release any unmanaged resources used by this object.

    Declaration
    public void Dispose()
    See Also
    Recorder
    View Source

    Dispose(bool)

    Releases the resources used by the StreamRecorder.

    Declaration
    protected virtual void Dispose(bool disposing)
    Parameters
    Type Name Description
    bool disposing

    true to release both managed and unmanaged resources; false to release only unmanaged resources.

    See Also
    Recorder
    View Source

    GetSupportedAudioCodecs()

    Gets the audio codecs that the current device supports.

    Declaration
    public IEnumerable<RecorderAudioCodec> GetSupportedAudioCodecs()
    Returns
    Type Description
    System.Collections.Generic.IEnumerable<T><RecorderAudioCodec>

    An IEnumerable of RecorderAudioCodec representing the supported audio codecs.

    See Also
    Recorder
    View Source

    GetSupportedFileFormats()

    Gets the file formats that the current device supports.

    Declaration
    public IEnumerable<RecorderFileFormat> GetSupportedFileFormats()
    Returns
    Type Description
    System.Collections.Generic.IEnumerable<T><RecorderFileFormat>

    An IEnumerable of RecorderFileFormat representing the supported file formats.

    See Also
    Recorder
    View Source

    GetSupportedVideoCodecs()

    Gets the video codecs that the current device supports.

    Declaration
    public IEnumerable<RecorderVideoCodec> GetSupportedVideoCodecs()
    Returns
    Type Description
    System.Collections.Generic.IEnumerable<T><RecorderVideoCodec>

    An IEnumerable of RecorderVideoCodec representing the supported video codecs.

    See Also
    Recorder
    View Source

    GetSupportedVideoResolutions()

    Gets the video resolutions that the current device supports.

    Declaration
    public IEnumerable<Size> GetSupportedVideoResolutions()
    Returns
    Type Description
    System.Collections.Generic.IEnumerable<T><Size>

    An IEnumerable of Size representing the supported resolutions.

    See Also
    Recorder
    View Source

    Pause()

    Pauses recording.

    Declaration
    public void Pause()
    Remarks

    Recording can be resumed with Start().

    The recorder state must be Recording state by Start().

    It has no effect if the recorder is already in the Paused state.

    Exceptions
    Type Condition
    System.InvalidOperationException

    The recorder is not in the valid state.

    System.ObjectDisposedException

    The StreamRecorder has already been disposed.

    See Also
    Start()
    Commit()
    Cancel()
    View Source

    Prepare(StreamRecorderOptions)

    Prepares the stream recorder with the specified options.

    Declaration
    public void Prepare(StreamRecorderOptions options)
    Parameters
    Type Name Description
    StreamRecorderOptions options

    The options for recording.

    Remarks

    The recorder must be Idle.

    Exceptions
    Type Condition
    System.InvalidOperationException

    The recorder is not in the valid state.

    System.ArgumentException

    Both Audio and Video are null.

    System.NotSupportedException

    options contains a value which is not supported.

    System.ObjectDisposedException

    The StreamRecorder has already been disposed.

    See Also
    Unprepare()
    Start()
    StreamRecorderOptions
    StreamRecorderAudioOptions
    StreamRecorderVideoOptions
    View Source

    PushBuffer(MediaPacket)

    Pushes a packet as recording raw data.

    Declaration
    public void PushBuffer(MediaPacket packet)
    Parameters
    Type Name Description
    MediaPacket packet

    An audio or video packet to record.

    Remarks

    The recorder state must be Recording state by Start().

    Exceptions
    Type Condition
    System.InvalidOperationException

    The recorder is not in the valid state.
    -or-
    packet is an audio packet but audio recording is not enabled(See Audio).
    -or-
    packet is a video packet but video recording is not enabled(See Video).
    -or-
    packet is a video packet but the MimeType does not match the video source format.
    -or-
    An internal error occurs.

    System.ObjectDisposedException

    The StreamRecorder has already been disposed.

    See Also
    Audio
    Video
    SourceFormat
    View Source

    Start()

    Starts recording.

    Declaration
    public void Start()
    Remarks

    The recorder state must be Ready state by Prepare(StreamRecorderOptions) or Paused state by Pause().

    It has no effect if the recorder is already in the Recording state.

    Exceptions
    Type Condition
    System.InvalidOperationException

    The recorder is not in the valid state.

    System.UnauthorizedAccessException

    The access of the resources can not be granted.

    System.ObjectDisposedException

    The StreamRecorder has already been disposed.

    See Also
    Pause()
    Commit()
    Cancel()
    View Source

    Unprepare()

    Unprepares the stream recorder.

    Declaration
    public void Unprepare()
    Remarks

    The recorder state must be Ready state by Prepare(StreamRecorderOptions), Cancel() and Commit().
    The recorder state will be Idle.

    It has no effect if the recorder is already in the Idle state.

    Exceptions
    Type Condition
    System.InvalidOperationException

    The recorder is not in the valid state.

    System.ObjectDisposedException

    The StreamRecorder has already been disposed.

    See Also
    Prepare(StreamRecorderOptions)

    Events

    View Source

    BufferConsumed

    Occurs when a buffer had consumed completely.

    Declaration
    public event EventHandler<StreamRecorderBufferConsumedEventArgs> BufferConsumed
    Event Type
    Type Description
    System.EventHandler<TEventArgs><StreamRecorderBufferConsumedEventArgs>
    See Also
    Recorder
    View Source

    ErrorOccurred

    Occurs when an error occurred during a recorder operation.

    Declaration
    public event EventHandler<StreamRecorderErrorOccurredEventArgs> ErrorOccurred
    Event Type
    Type Description
    System.EventHandler<TEventArgs><StreamRecorderErrorOccurredEventArgs>
    See Also
    Recorder
    View Source

    RecordingLimitReached

    Occurs when recording limit is reached.

    Declaration
    public event EventHandler<RecordingLimitReachedEventArgs> RecordingLimitReached
    Event Type
    Type Description
    System.EventHandler<TEventArgs><RecordingLimitReachedEventArgs>
    See Also
    Recorder
    View Source

    RecordingStatusChanged

    Occurs when recording status is changed.

    Declaration
    public event EventHandler<RecordingStatusChangedEventArgs> RecordingStatusChanged
    Event Type
    Type Description
    System.EventHandler<TEventArgs><RecordingStatusChangedEventArgs>
    See Also
    Recorder
    View Source

    StateChanged

    Occurs when StreamRecorder state is changed.

    Declaration
    public event EventHandler<StreamRecorderStateChangedEventArgs> StateChanged
    Event Type
    Type Description
    System.EventHandler<TEventArgs><StreamRecorderStateChangedEventArgs>
    See Also
    Recorder

    Implements

    System.IDisposable

    See Also

    Recorder
    • View Source
    Back to top Copyright © 2016-2024 Samsung
    Generated by DocFX