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
-
objectStreamRecorder
- Implements
-
System.IDisposable
Constructors
View SourceStreamRecorder()
Initialize a new instance of the StreamRecorder class.
Declaration
public StreamRecorder()
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | The feature is not supported. |
See Also
Properties
View SourceState
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
Methods
View SourceCancel()
Cancels recording. The recording data is discarded and not written.
Declaration
public void Cancel()
Remarks
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | The recorder is not in the valid state. |
System.ObjectDisposedException | The StreamRecorder has already been disposed. |
See Also
View SourceCommit()
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
View SourceDispose()
Release any unmanaged resources used by this object.
Declaration
public void Dispose()
See Also
View SourceDispose(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
View SourceGetSupportedAudioCodecs()
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
View SourceGetSupportedFileFormats()
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
View SourceGetSupportedVideoCodecs()
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
View SourceGetSupportedVideoResolutions()
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
View SourcePause()
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
View SourcePrepare(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 | |
System.NotSupportedException |
|
System.ObjectDisposedException | The StreamRecorder has already been disposed. |
See Also
View SourcePushBuffer(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
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | The recorder is not in the valid state. |
System.ObjectDisposedException | The StreamRecorder has already been disposed. |
See Also
View SourceStart()
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
View SourceUnprepare()
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
Events
View SourceBufferConsumed
Occurs when a buffer had consumed completely.
Declaration
public event EventHandler<StreamRecorderBufferConsumedEventArgs> BufferConsumed
Event Type
Type | Description |
---|---|
System.EventHandler<TEventArgs><StreamRecorderBufferConsumedEventArgs> |
See Also
View SourceErrorOccurred
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
View SourceRecordingLimitReached
Occurs when recording limit is reached.
Declaration
public event EventHandler<RecordingLimitReachedEventArgs> RecordingLimitReached
Event Type
Type | Description |
---|---|
System.EventHandler<TEventArgs><RecordingLimitReachedEventArgs> |
See Also
View SourceRecordingStatusChanged
Occurs when recording status is changed.
Declaration
public event EventHandler<RecordingStatusChangedEventArgs> RecordingStatusChanged
Event Type
Type | Description |
---|---|
System.EventHandler<TEventArgs><RecordingStatusChangedEventArgs> |
See Also
View SourceStateChanged
Occurs when StreamRecorder state is changed.
Declaration
public event EventHandler<StreamRecorderStateChangedEventArgs> StateChanged
Event Type
Type | Description |
---|---|
System.EventHandler<TEventArgs><StreamRecorderStateChangedEventArgs> |