NVIDIA DeepStream SDK API Reference

9.2 Release
sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/h/rs_record_playback.h File Reference

Detailed Description

Exposes record and playback functionality for C compilers.

Definition in file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/h/rs_record_playback.h.

Go to the source code of this file.

Typedefs

typedef enum rs2_playback_status rs2_playback_status
 
typedef void(* rs2_playback_status_changed_callback_ptr) (rs2_playback_status)
 

Enumerations

enum  rs2_playback_status {
  RS2_PLAYBACK_STATUS_UNKNOWN,
  RS2_PLAYBACK_STATUS_PLAYING,
  RS2_PLAYBACK_STATUS_PAUSED,
  RS2_PLAYBACK_STATUS_STOPPED,
  RS2_PLAYBACK_STATUS_COUNT,
  RS2_PLAYBACK_STATUS_UNKNOWN,
  RS2_PLAYBACK_STATUS_PLAYING,
  RS2_PLAYBACK_STATUS_PAUSED,
  RS2_PLAYBACK_STATUS_STOPPED,
  RS2_PLAYBACK_STATUS_COUNT
}
 

Functions

const char * rs2_playback_status_to_string (rs2_playback_status status)
 
rs2_device * rs2_create_record_device (const rs2_device *device, const char *file, rs2_error **error)
 Creates a recording device to record the given device and save it to the given file. More...
 
rs2_device * rs2_create_record_device_ex (const rs2_device *device, const char *file, int compression_enabled, rs2_error **error)
 Creates a recording device to record the given device and save it to the given file. More...
 
void rs2_record_device_pause (const rs2_device *device, rs2_error **error)
 Pause the recording device without stopping the actual device from streaming. More...
 
void rs2_record_device_resume (const rs2_device *device, rs2_error **error)
 Unpause the recording device. More...
 
const char * rs2_record_device_filename (const rs2_device *device, rs2_error **error)
 Gets the name of the file to which the recorder is writing. More...
 
rs2_device * rs2_create_playback_device (const char *file, rs2_error **error)
 Creates a playback device to play the content of the given file. More...
 
const char * rs2_playback_device_get_file_path (const rs2_device *device, rs2_error **error)
 Gets the path of the file used by the playback device. More...
 
unsigned long long int rs2_playback_get_duration (const rs2_device *device, rs2_error **error)
 Gets the total duration of the file in units of nanoseconds. More...
 
void rs2_playback_seek (const rs2_device *device, long long int time, rs2_error **error)
 Set the playback to a specified time point of the played data. More...
 
unsigned long long int rs2_playback_get_position (const rs2_device *device, rs2_error **error)
 Gets the current position of the playback in the file in terms of time. More...
 
void rs2_playback_device_resume (const rs2_device *device, rs2_error **error)
 Pauses the playback Calling pause() in "Paused" status does nothing If pause() is called while playback status is "Playing" or "Stopped", the playback will not play until resume() is called. More...
 
void rs2_playback_device_pause (const rs2_device *device, rs2_error **error)
 Un-pauses the playback Calling resume() while playback status is "Playing" or "Stopped" does nothing. More...
 
void rs2_playback_device_set_real_time (const rs2_device *device, int real_time, rs2_error **error)
 Set the playback to work in real time or non real time. More...
 
int rs2_playback_device_is_real_time (const rs2_device *device, rs2_error **error)
 Indicates if playback is in real time mode or non real time. More...
 
void rs2_playback_device_set_status_changed_callback (const rs2_device *device, rs2_playback_status_changed_callback *callback, rs2_error **error)
 Register to receive callback from playback device upon its status changes. More...
 
rs2_playback_status rs2_playback_device_get_current_status (const rs2_device *device, rs2_error **error)
 Returns the current state of the playback device. More...
 
void rs2_playback_device_set_playback_speed (const rs2_device *device, float speed, rs2_error **error)
 Set the playing speed. More...
 
void rs2_playback_device_stop (const rs2_device *device, rs2_error **error)
 Stops the playback Calling stop() will stop all streaming playbakc sensors and will reset the playback (returning to beginning of file) More...
 

Typedef Documentation

◆ rs2_playback_status

◆ rs2_playback_status_changed_callback_ptr

typedef void(* rs2_playback_status_changed_callback_ptr) (rs2_playback_status)

Enumeration Type Documentation

◆ rs2_playback_status

Enumerator
RS2_PLAYBACK_STATUS_UNKNOWN 

Unknown state.

RS2_PLAYBACK_STATUS_PLAYING 

One or more sensors were started, playback is reading and raising data.

RS2_PLAYBACK_STATUS_PAUSED 

One or more sensors were started, but playback paused reading and paused raising data.

RS2_PLAYBACK_STATUS_STOPPED 

All sensors were stopped, or playback has ended (all data was read).

This is the initial playback status

RS2_PLAYBACK_STATUS_COUNT 
RS2_PLAYBACK_STATUS_UNKNOWN 

Unknown state.

RS2_PLAYBACK_STATUS_PLAYING 

One or more sensors were started, playback is reading and raising data.

RS2_PLAYBACK_STATUS_PAUSED 

One or more sensors were started, but playback paused reading and paused raising data.

RS2_PLAYBACK_STATUS_STOPPED 

All sensors were stopped, or playback has ended (all data was read).

This is the initial playback status

RS2_PLAYBACK_STATUS_COUNT 

Definition at line 19 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/h/rs_record_playback.h.

Function Documentation

◆ rs2_create_playback_device()

rs2_device* rs2_create_playback_device ( const char *  file,
rs2_error **  error 
)

Creates a playback device to play the content of the given file.

Parameters
[in]filePath to the file to play
[out]errorIf non-null, receives any error that occurs during this call, otherwise, errors are ignored
Returns
A pointer to a device that plays data from the file, or null in case of failure

◆ rs2_create_record_device()

rs2_device* rs2_create_record_device ( const rs2_device *  device,
const char *  file,
rs2_error **  error 
)

Creates a recording device to record the given device and save it to the given file.

Parameters
[in]deviceThe device to record
[in]fileThe desired path to which the recorder should save the data
[out]errorIf non-null, receives any error that occurs during this call, otherwise, errors are ignored
Returns
A pointer to a device that records its data to file, or null in case of failure

Referenced by rs2::recorder::recorder().

◆ rs2_create_record_device_ex()

rs2_device* rs2_create_record_device_ex ( const rs2_device *  device,
const char *  file,
int  compression_enabled,
rs2_error **  error 
)

Creates a recording device to record the given device and save it to the given file.

Parameters
[in]deviceThe device to record
[in]fileThe desired path to which the recorder should save the data
[in]compression_enabledIndicates if compression is enabled, 0 means false, otherwise true
[out]errorIf non-null, receives any error that occurs during this call, otherwise, errors are ignored
Returns
A pointer to a device that records its data to file, or null in case of failure

Referenced by rs2::recorder::recorder().

◆ rs2_playback_device_get_current_status()

rs2_playback_status rs2_playback_device_get_current_status ( const rs2_device *  device,
rs2_error **  error 
)

Returns the current state of the playback device.

Parameters
[in]deviceA playback device
[out]errorIf non-null, receives any error that occurs during this call, otherwise, errors are ignored
Returns
Current state of the playback

Referenced by rs2::playback::current_status().

◆ rs2_playback_device_get_file_path()

const char* rs2_playback_device_get_file_path ( const rs2_device *  device,
rs2_error **  error 
)

Gets the path of the file used by the playback device.

Parameters
[in]deviceA playback device
[out]errorIf non-null, receives any error that occurs during this call, otherwise, errors are ignored
Returns
Path to the file used by the playback device

Referenced by rs2::playback::playback().

◆ rs2_playback_device_is_real_time()

int rs2_playback_device_is_real_time ( const rs2_device *  device,
rs2_error **  error 
)

Indicates if playback is in real time mode or non real time.

Parameters
[in]deviceA playback device
[out]errorIf non-null, receives any error that occurs during this call, otherwise, errors are ignored
Returns
True iff playback is in real time mode. 0 means false, otherwise true

Referenced by rs2::playback::is_real_time().

◆ rs2_playback_device_pause()

void rs2_playback_device_pause ( const rs2_device *  device,
rs2_error **  error 
)

Un-pauses the playback Calling resume() while playback status is "Playing" or "Stopped" does nothing.

Parameters
[in]deviceA playback device
[out]errorIf non-null, receives any error that occurs during this call, otherwise, errors are ignored

Referenced by rs2::playback::pause().

◆ rs2_playback_device_resume()

void rs2_playback_device_resume ( const rs2_device *  device,
rs2_error **  error 
)

Pauses the playback Calling pause() in "Paused" status does nothing If pause() is called while playback status is "Playing" or "Stopped", the playback will not play until resume() is called.

Parameters
[in]deviceA playback device
[out]errorIf non-null, receives any error that occurs during this call, otherwise, errors are ignored

Referenced by rs2::playback::resume().

◆ rs2_playback_device_set_playback_speed()

void rs2_playback_device_set_playback_speed ( const rs2_device *  device,
float  speed,
rs2_error **  error 
)

Set the playing speed.

Parameters
[in]deviceA playback device
[in]speedIndicates a multiplication of the speed to play (e.g: 1 = normal, 0.5 twice as slow)
[out]errorIf non-null, receives any error that occurs during this call, otherwise, errors are ignored

Referenced by rs2::playback::set_playback_speed().

◆ rs2_playback_device_set_real_time()

void rs2_playback_device_set_real_time ( const rs2_device *  device,
int  real_time,
rs2_error **  error 
)

Set the playback to work in real time or non real time.

In real time mode, playback will play the same way the file was recorded. In real time mode if the application takes too long to handle the callback, frames may be dropped. In non real time mode, playback will wait for each callback to finish handling the data before reading the next frame. In this mode no frames will be dropped, and the application controls the frame rate of the playback (according to the callback handler duration).

Parameters
[in]deviceA playback device
[in]real_timeIndicates if real time is requested, 0 means false, otherwise true
[out]errorIf non-null, receives any error that occurs during this call, otherwise, errors are ignored

Referenced by rs2::playback::set_real_time().

◆ rs2_playback_device_set_status_changed_callback()

void rs2_playback_device_set_status_changed_callback ( const rs2_device *  device,
rs2_playback_status_changed_callback *  callback,
rs2_error **  error 
)

Register to receive callback from playback device upon its status changes.

Callbacks are invoked from the reading thread, any heavy processing in the callback handler will affect the reading thread and may cause frame drops\ high latency

Parameters
[in]deviceA playback device
[in]callbackA callback handler that will be invoked when the playback status changes
[out]errorIf non-null, receives any error that occurs during this call, otherwise, errors are ignored

Referenced by rs2::playback::set_status_changed_callback().

◆ rs2_playback_device_stop()

void rs2_playback_device_stop ( const rs2_device *  device,
rs2_error **  error 
)

Stops the playback Calling stop() will stop all streaming playbakc sensors and will reset the playback (returning to beginning of file)

Parameters
[in]deviceA playback device
[out]errorIf non-null, receives any error that occurs during this call, otherwise, errors are ignored

Referenced by rs2::playback::stop().

◆ rs2_playback_get_duration()

unsigned long long int rs2_playback_get_duration ( const rs2_device *  device,
rs2_error **  error 
)

Gets the total duration of the file in units of nanoseconds.

Parameters
[in]deviceA playback device
[out]errorIf non-null, receives any error that occurs during this call, otherwise, errors are ignored
Returns
Total duration of the file in units of nanoseconds

Referenced by rs2::playback::get_duration().

◆ rs2_playback_get_position()

unsigned long long int rs2_playback_get_position ( const rs2_device *  device,
rs2_error **  error 
)

Gets the current position of the playback in the file in terms of time.

Units are expressed in nanoseconds

Parameters
[in]deviceA playback device
[out]errorIf non-null, receives any error that occurs during this call, otherwise, errors are ignored
Returns
Current position of the playback in the file in terms of time. Units are expressed in nanoseconds

Referenced by rs2::playback::get_position().

◆ rs2_playback_seek()

void rs2_playback_seek ( const rs2_device *  device,
long long int  time,
rs2_error **  error 
)

Set the playback to a specified time point of the played data.

Parameters
[in]deviceA playback device.
[in]timeThe time point to which playback should seek, expressed in units of nanoseconds (zero value = start)
[out]errorIf non-null, receives any error that occurs during this call, otherwise, errors are ignored

Referenced by rs2::playback::seek().

◆ rs2_playback_status_to_string()

const char* rs2_playback_status_to_string ( rs2_playback_status  status)

Referenced by operator<<().

◆ rs2_record_device_filename()

const char* rs2_record_device_filename ( const rs2_device *  device,
rs2_error **  error 
)

Gets the name of the file to which the recorder is writing.

Parameters
[in]deviceA recording device
[out]errorIf non-null, receives any error that occurs during this call, otherwise, errors are ignored
Returns
The name of the file to which the recorder is writing

Referenced by rs2::recorder::filename().

◆ rs2_record_device_pause()

void rs2_record_device_pause ( const rs2_device *  device,
rs2_error **  error 
)

Pause the recording device without stopping the actual device from streaming.

Pausing will cause the device to stop writing new data to the file, in particular, frames and changes to extensions

Parameters
[in]deviceA recording device
[out]errorIf non-null, receives any error that occurs during this call, otherwise, errors are ignored

Referenced by rs2::recorder::pause().

◆ rs2_record_device_resume()

void rs2_record_device_resume ( const rs2_device *  device,
rs2_error **  error 
)

Unpause the recording device.

Resume will cause the device to continue writing new data to the file, in particular, frames and changes to extensions

Parameters
[in]deviceA recording device
[out]errorIf non-null, receives any error that occurs during this call, otherwise, errors are ignored

Referenced by rs2::recorder::resume().