Class StreamRecorder

View Source

Definition

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

Provides the ability to record user buffer from application.


                
C#

                

                    
Copy

                    

                

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

Constructors

View Source

StreamRecorder()

Initialize a new instance of the StreamRecorder class.

Declaration

                
C#

                

                    
Copy

                    

                

            
public StreamRecorder()
Exceptions
Type Condition
System.NotSupportedException

The feature is not supported.
See Also

Properties

View Source

State

Gets the current state of the stream recorder.

Declaration

                
C#

                

                    
Copy

                    

                

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

The StreamRecorder has already been disposed.
See Also

Methods

View Source

Cancel()

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

Declaration

                
C#

                

                    
Copy

                    

                

            
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
View Source

Commit()

Stops recording and saves the result.

Declaration

                
C#

                

                    
Copy

                    

                

            
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 Source

Dispose()

Release any unmanaged resources used by this object.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void Dispose()
See Also
View Source

Dispose(bool)

Releases the resources used by the StreamRecorder.

Declaration

                
C#

                

                    
Copy

                    

                

            
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 Source

GetSupportedAudioCodecs()

Gets the audio codecs that the current device supports.

Declaration

                
C#

                

                    
Copy

                    

                

            
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 Source

GetSupportedFileFormats()

Gets the file formats that the current device supports.

Declaration

                
C#

                

                    
Copy

                    

                

            
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 Source

GetSupportedVideoCodecs()

Gets the video codecs that the current device supports.

Declaration

                
C#

                

                    
Copy

                    

                

            
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 Source

GetSupportedVideoResolutions()

Gets the video resolutions that the current device supports.

Declaration

                
C#

                

                    
Copy

                    

                

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

An IEnumerable of Size representing the supported resolutions.
See Also
View Source

Pause()

Pauses recording.

Declaration

                
C#

                

                    
Copy

                    

                

            
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 Source

Prepare(StreamRecorderOptions)

Prepares the stream recorder with the specified options.

Declaration

                
C#

                

                    
Copy

                    

                

            
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
View Source

PushBuffer(MediaPacket)

Pushes a packet as recording raw data.

Declaration

                
C#

                

                    
Copy

                    

                

            
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
View Source

Start()

Starts recording.

Declaration

                
C#

                

                    
Copy

                    

                

            
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 Source

Unprepare()

Unprepares the stream recorder.

Declaration

                
C#

                

                    
Copy

                    

                

            
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 Source

BufferConsumed

Occurs when a buffer had consumed completely.

Declaration

                
C#

                

                    
Copy

                    

                

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

ErrorOccurred

Occurs when an error occurred during a recorder operation.

Declaration

                
C#

                

                    
Copy

                    

                

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

RecordingLimitReached

Occurs when recording limit is reached.

Declaration

                
C#

                

                    
Copy

                    

                

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

RecordingStatusChanged

Occurs when recording status is changed.

Declaration

                
C#

                

                    
Copy

                    

                

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

StateChanged

Occurs when StreamRecorder state is changed.

Declaration

                
C#

                

                    
Copy

                    

                

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

Implements

System.IDisposable

See Also