API Overview

RCP API Information

function	description
rcp_api_get_version	Get version of RCP API.

function	description
rcp_create_camera_connection	Create camera connection to the RCP API.
rcp_delete_camera_connection	Close and cleanup camera connection.
rcp_camera_connection_stats	Get stats regarding camera connection.

function	description
rcp_discovery_start	Start camera discovery process.
rcp_discovery_step	Continue camera discovery process.
rcp_discovery_get_list	Get list of discovered cameras.
rcp_discovery_free_list	Clears list of discovered cameras.
rcp_discovery_process_data	Process incoming discovery camera data.
rcp_discovery_end	End the camera discovery process.

function	description
rcp_get	Request RCP parameter data from the camera.
rcp_get_list	Request RCP parameter list from the camera.
rcp_get_status	Request RCP parameter status from the camera.
rcp_get_default	Request RCP parameter default value from the camera.
rcp_send	Send RCP parameter to camera.
rcp_set_int	Set integer value for RCP parameter.
rcp_set_int_relative	Set integer value for RCP parameter given an offset.
rcp_set_uint	Set unsigned integer value for RCP parameter.
rcp_set_uint_relative	Set unsigned integer value for RCP parameter given an offset.
rcp_set_str	Set string value for RCP parameter.
rcp_set_list	Set list value for RCP parameter.
rcp_set_list_relative	Set list (by value) with relative offset.
rcp_get_periodic_is_supported	Check if the get_periodic feature is supported by connected camera.
rcp_get_periodic_on	Enable periodic RCP parameter data from the camera.
rcp_get_periodic_off	Disable periodic RCP parameter data from the camera.

function	description
rcp_notification_get	Get current notification.
rcp_notification_timeout	Current notification has timed out.
rcp_notification_response	Send response for current notification.

function	description
rcp_get_name	Get name of RCP parameter.
rcp_get_label	Get label for RCP parameter.
rcp_get_id	Get ID for RCP parameter by name.
rcp_get_update_list_only_on_close	(DEPRECATED) Get update_list_only_on_close property of RCP parameter.
rcp_get_is_supported	Check if parameter is supported by connected camera.

function	description
rcp_menu_is_supported	Check if menu tree is supported by connected camera.
rcp_menu_get_children	Request menu tree children for given parent node.
rcp_menu_node_status_is_supported	Check if menu node status is supported by connected camera.
rcp_menu_get_node_status	Request menu tree status for given node.
rcp_menu_get_multi_action_list_leaf_flags	Convert user-defined int32 value in arg_c_list for multi action list leaf into flags.

function	description
rcp_rftp_is_supported	Check if rftp operations are supported by connected camera.
rcp_rftp_tethered_is_supported	Check if rftp tethered file retrieval is supported by connected camera.
rcp_rftp_send_file	Send file to camera.
rcp_rftp_retrieve_file	Retrieve file from camera.
rcp_rftp_retrieve_file_tethered	Retrieve file from camera using the RED streaming protocol (for internal RED use only)
rcp_rftp_abort_transfer	Abort store or retrieve file transfer.
rcp_rftp_delete_file	Delete file from camera.
rcp_rftp_directory_listing	Get virtual directory listing from camera.

function	description
rcp_user_is_supported	Check if user pass through messages are supported by connected camera.
rcp_user_send_set	Send "Set USER" RCP Message.
rcp_user_send_get	Send "Get USER" RCP Message.
rcp_user_send_current	Send "Current USER" RCP Message.

function	description
rcp_user_metadata_is_supported	Check if user metadata messages are supported by connected camera.
rcp_user_metadata_register	Register user metadata id with camera.
rcp_user_metadata_unregister	Unregister user metadata id with camera.
rcp_user_metadata_send	Send user metadata to camera.

function	description
rcp_key_mapping_is_supported	Check if key mapping is supported by connected camera. Check if key mapping is supported via RCP by connected camera. This function uses the camera's RCP Parameter Set Version to determine if is is available.
rcp_key_mapping_get_action_list	Request list of mappable actions from the camera.
rcp_key_mapping_get_mapping	Request current key-mapping for given keycode.
rcp_key_mapping_set_mapping	Set key-mapping for given keycode.

function	description
rcp_malloc	Wrapper for memory allocations required by RCP API.
rcp_free	Wrapper for freeing memory allocations required by RCP API.
rcp_mutex_lock	Wrapper for mutex lock required by the RCP API.
rcp_mutex_unlock	Wrapper for mutex unlock required by the RCP API.
rcp_log	Wrapper for logging messages from the RCP API.
rcp_rand	Wrapper for getting pseudo-random integer required by the RCP API.
rcp_timestamp	Wrapper for getting system time stamp in milliseconds.

The API build can be customized to fit the needs of your target platform - for details see rcp_api_config.h