com.red.rcp.RCPCameraListener Interface Reference

RCP Camera Listener. More...

Inheritance diagram for com.red.rcp.RCPCameraListener:

Public Member Functions
void	onUpdate (String id, String param)
	Invoked when a formatted camera integer parameter has been updated. More...
void	onUpdateInt (String id, String param, int value)
	Invoked when a camera integer parameter has been updated. More...
void	onUpdateString (String id, String param)
	Invoked when a camera string parameter has been updated. More...
void	onUpdateStringEditInfo (final String id, final String paramName, final int[] intParams, final String[] strParams)
	Invoked when edit info of a string parameter has been updated. More...
void	onUpdateClipList (String id, int status, String clipList)
	Invoked when a camera clip list event has occurred. More...
void	onUpdateEditInfo (String id, String editInfo)
	Invoked when edit info of a parameter has been updated. More...
void	onUpdateListStrings (String id, String listHeader, String listFlags, String[] listStrings, int[] listValues)
	Invoked when a camera list has been updated. More...
void	onUpdateHistogram (String id, int[] red, int[] green, int[] blue, int[] luma, int bottom_clip, int top_clip, String text)
	Invoked when a camera histogram has been updated. More...
void	onUpdateTag (String id, String param)
	Invoked when camera tag information has been updated. More...
void	onStateChange (String id, String param)
	Invoked when a connection state change occurs. More...
void	onStatusUpdate (String id, String param, int isEnabled, int isEnabledValid, int isSupported, int isSupportedValid)
	Invoked when the status of a parameter changes. More...
void	onNotificationUpdate (String id, String nID, String title, String message, String notificationInfo)
	Invoked when a camera notification is opened, updated, or closed. More...
void	onAudioVuUpdate (final String id, final String audioVu)
	Invoked when audio input and output volumes on the camera are updated. More...
void	onMenuNodeListUpdate (String id, int nodeId, String[] childList, String[] ancestorList)
	Invoked when menu node list is updated on the camera. More...
void	onMenuNodeStatusUpdate (String id, int nodeId, int isEnabled, int isEnabledValid, int isSupported, int isSupportedValid)
	Invoked when menu node list is updated on the camera. More...
void	onConnectionError (String id, String msg)
	Invoked when there is a camera connection error detected in the JNI code. More...
void	onCameraInfo (String id, String camInfo)
	Invoked when a connection state change occurs. More...
void	onRftpStatusUpdate (String id, byte[] uuid, int rftpType, int rftpError, int percentComplete, String[] dirList)
	Invoked to update the progress on previously initiated RFTP transfer. More...

Detailed Description

RCP Camera Listener.

Implementation of this interface handles events dispatched to RCPCamera. RCP Camera Listener defines the callback interface that will be called when the connected camera sends data to a RCPCamera object. This interface must also be implemented by any classes that instantiate a RCPCamera object, as the callback methods are delegated to the parent class.

Member Function Documentation

onUpdate()

void com.red.rcp.RCPCameraListener.onUpdate	(	String	id,
		String	param
	)

Invoked when a formatted camera integer parameter has been updated.

For this callback to be invoked, one of the following callback conditions exist in the SDK callback cur_int_cb:

• display_string_valid is true
• id == RCP_PARAM_RECORD_STATE and cur_val_valid is true

The param string is delimited in the following manner: "[Parameter Name];[Value];[Abbreviated Value];[Color]"

Parameters

id	identifies the RCPCamera object
param	defines the parameter values as a string

Implemented in com.red.rcp.RCPCamera.

onUpdateInt()

void com.red.rcp.RCPCameraListener.onUpdateInt	(	String	id,
		String	param,
		int	value
	)

Invoked when a camera integer parameter has been updated.

For this callback to be invoked, the following conditions must exist in the SDK callback cur_int_cb:

• display_string_valid is false
• id != RCP_PARAM_RECORD_STATE
• cur_val_valid is true

Parameters

id	identifies the RCPCamera object
param	name of the parameter
value	integer value of the parameter

Implemented in com.red.rcp.RCPCamera.

onUpdateString()

void com.red.rcp.RCPCameraListener.onUpdateString	(	String	id,
		String	param
	)

Invoked when a camera string parameter has been updated.

For this callback to be invoked, the following conditions must exist in the SDK callback cur_list_cb:

• display_str_in_list is true

The callback will also be invoked if the following conditions exist in the SDK callback cur_str_cb:

• display_str is true

The param string is delimited in the following manner: "[Parameter Name];[Value];[Abbreviated Value];[Color]"

Parameters

id	identifies the RCPCamera object
param	defines the parameter values as a string

Implemented in com.red.rcp.RCPCamera.

onUpdateStringEditInfo()

void com.red.rcp.RCPCameraListener.onUpdateStringEditInfo	(	final String	id,
		final String	paramName,
		final int []	intParams,
		final String []	strParams
	)

Invoked when edit info of a string parameter has been updated.

For this callback to be invoked, the following conditions must exist in the SDK callback cur_str_cb:

• edit_info_valid is true

The editInfo integers are indexed in the following manner: "[0]=min_length,[1]=max_length,[2]=is_password The editInfo strings are indexed in the following manner: "[0]=allowed_chars,[1]=prefix_decoded,[2]=suffix_decoded

Parameters

id	identifies the RCPCamera object
paramName	RCP parameter name the edit info values as a string
intParams	Integer edit_info parameters passed as an array
strParams	String edit_info parameters passed as an array

Implemented in com.red.rcp.RCPCamera.

onUpdateClipList()

void com.red.rcp.RCPCameraListener.onUpdateClipList	(	String	id,
		int	status,
		String	clipList
	)

Invoked when a camera clip list event has occurred.

When this method is invoked, the clip list status will either be Loading, Blocked or Done. See the SDK documentation and source code for enumeration values.

If the status is Loading or Blocked, clipList will be null. If the status is Done, clipList could be null if their are no media clips on the camera.

If clipList is not null, then the string will be formatted as follows: "[Clip 1];[Clip 2];...;[Clip N]" where each clip is formatted as follows: "[Index]|[Name]|[Date]|[Time]|[FPS]|[Edge Start Timecode]|[Edge End Timecode]|[TOD Start Timecode]|[TOD End Timecode]"

Parameters

id	identifies the RCPCamera object
status	clip list status: Loading, Blocked, Done
clipList	string list of clips formatted as shown above

Implemented in com.red.rcp.RCPCamera.

onUpdateEditInfo()

void com.red.rcp.RCPCameraListener.onUpdateEditInfo	(	String	id,
		String	editInfo
	)

Invoked when edit info of a parameter has been updated.

For this callback to be invoked, the following conditions must exist in the SDK callback cur_int_cb:

• edit_info_valid is true

The callback will also be invoked if the following conditions exist in the SDK callback cur_uint_cb:

• edit_info_valid is true

The editInfo string is delimited in the following manner: "[Parameter Name];[Min Value];[Max Value];[Divider];[Digits];[Step];[Prefix];[Suffix]"

Parameters

id	identifies the RCPCamera object
param	defines the edit info values as a string

Implemented in com.red.rcp.RCPCamera.

onUpdateListStrings()

void com.red.rcp.RCPCameraListener.onUpdateListStrings	(	String	id,
		String	listHeader,
		String	listFlags,
		String []	listStrings,
		int []	listValues
	)

Invoked when a camera list has been updated.

For this callback to be invoked, the following condition must exist in the SDK callback cur_list_cb:

• list_string_valid is true

The list is then decoded and formatted as follows:

• listHeader = "[Param Name]|[Length]|[Selected Index]|[Min Valid Flag]|[Min Value]|[Max Valid Flag]|[Max Value]"
• listStrings = "[Item Str1]|[Item Str2]|...|[Item StrN]"
• listValues = "[Item Value1]|[Item Value2]|...|[Item Value3]"
• listFlags = "[Send Int Flag]|[Send Uint Flag|[Send Str Flag]|[Update List Only On Close Flag]"
  id identifies the RCPCamera object

  Parameters

  listHeader	identifies the list name and important meta-data
  listStrings	array of the string names to be displayed in the list
  listValues	array of the integer values associated with the string names
  listFlags	boolean flags pertaining to the list

Implemented in com.red.rcp.RCPCamera.

onUpdateHistogram()

void com.red.rcp.RCPCameraListener.onUpdateHistogram	(	String	id,
		int []	red,
		int []	green,
		int []	blue,
		int []	luma,
		int	bottom_clip,
		int	top_clip,
		String	text
	)

Invoked when a camera histogram has been updated.

The histogram contains red, green, blue and luma bins. There are 128 bins per channel with a max bin value of 16. Also included are clip levels that indicate a percent clip level at the bottom and top of the pixel range. The text is an abbreviated display string. See the SDK documentation for detailed information.

Parameters

id	identifies the RCPCamera object
red	integer array of red histogram values
green	integer array of green histogram values
blue	integer array of blue histogram values
luma	integer array of luma histogram values
bottom_clip	percentage of pixels clipped at the bottom of the dynamic range
top_clip	percentage of pixels clipped at the top of the dynamic range
text	abbreviated display string

Implemented in com.red.rcp.RCPCamera.

onUpdateTag()

void com.red.rcp.RCPCameraListener.onUpdateTag	(	String	id,
		String	param
	)

Invoked when camera tag information has been updated.

The format of the param string is "[Param Name];[Tag Type];[Tag Frame];[Timecode]"

Parameters

id	identifies the RCPCamera object
param	string identifying the tag information

Implemented in com.red.rcp.RCPCamera.

onStateChange()

void com.red.rcp.RCPCameraListener.onStateChange	(	String	id,
		String	param
	)

Invoked when a connection state change occurs.

The states include Init, Connected, RCP Version Mismatch, RCP Parameter Set Version Mismatch and Communication Error. See the SDK documentation callback cur_state_cb.

Parameters

id	identifies the RCPCamera object
param	string containing camera version info

Implemented in com.red.rcp.RCPCamera.

onStatusUpdate()

void com.red.rcp.RCPCameraListener.onStatusUpdate	(	String	id,
		String	param,
		int	isEnabled,
		int	isEnabledValid,
		int	isSupported,
		int	isSupportedValid
	)

Invoked when the status of a parameter changes.

See the SDK documentation callback cur_status_cb.

Parameters

id	identifies the RCPCamera object
param	string containing the parameter
isEnabled	1 if enabled, 0 if not
isEnabledValid	1 if the isEnabled field is valid
isSupported	1 if supported by hw, 0 if not
isSupportedValid	1 if the isSupported field is valid

Implemented in com.red.rcp.RCPCamera.

onNotificationUpdate()

void com.red.rcp.RCPCameraListener.onNotificationUpdate	(	String	id,
		String	nID,
		String	title,
		String	message,
		String	notificationInfo
	)

Invoked when a camera notification is opened, updated, or closed.

See the SDK documentation callback notification_cb.

Parameters

id	identifies the RCPCamera object
notificationInfo	string detailing info of the notification

Implemented in com.red.rcp.RCPCamera.

onAudioVuUpdate()

void com.red.rcp.RCPCameraListener.onAudioVuUpdate	(	final String	id,
		final String	audioVu
	)

Invoked when audio input and output volumes on the camera are updated.

The audioVu string contains the volumes in db of the four input channels and six output channels in the following format: "[input1];[input2];[input3];[input4]; [output0];[output1];[output2];[output3];[output4];[output5];[output6]" See the SDK documentation callback cur_audio_vu_cb.

Parameters

id	identifies the RCPCamera object
audioVu	string listing the audio input and output volumes

Implemented in com.red.rcp.RCPCamera.

onMenuNodeListUpdate()

void com.red.rcp.RCPCameraListener.onMenuNodeListUpdate	(	String	id,
		int	nodeId,
		String []	childList,
		String []	ancestorList
	)

Invoked when menu node list is updated on the camera.

See the SDK documentation callback cur_menu_cb.

Parameters

id	identifies the RCPCamera object
childList	string array listing the child nodes
ancestorList	string array listing the ancestor nodes

Implemented in com.red.rcp.RCPCamera.

onMenuNodeStatusUpdate()

void com.red.rcp.RCPCameraListener.onMenuNodeStatusUpdate	(	String	id,
		int	nodeId,
		int	isEnabled,
		int	isEnabledValid,
		int	isSupported,
		int	isSupportedValid
	)

Invoked when menu node list is updated on the camera.

See the SDK documentation callback cur_menu_cb.

Parameters

id	identifies the RCPCamera object
nodeId	identifies the menu node
isEnabled	1 if enabled, 0 if not
isEnabledValid	1 if the isEnabled field is valid
isSupported	1 if supported by hw, 0 if not
isSupportedValid	1 if the isSupported field is valid

Implemented in com.red.rcp.RCPCamera.

onConnectionError()

void com.red.rcp.RCPCameraListener.onConnectionError	(	String	id,
		String	msg
	)

Invoked when there is a camera connection error detected in the JNI code.

The provided message will detail the error that occurred.

Parameters

id	identifies the RCPCamera object
msg	message detailing the error that occurred at the JNI level

Implemented in com.red.rcp.RCPCamera.

onCameraInfo()

void com.red.rcp.RCPCameraListener.onCameraInfo	(	String	id,
		String	camInfo
	)

Invoked when a connection state change occurs.

The camInfo string returns detailed camera information. The format of the camInfo is "[Name];[PIN];[Type];[Version]".

Parameters

id	identifies the RCPCamera object
camInfo	detailed camera information as a string

Implemented in com.red.rcp.RCPCamera.

onRftpStatusUpdate()

void com.red.rcp.RCPCameraListener.onRftpStatusUpdate	(	String	id,
		byte []	uuid,
		int	rftpType,
		int	rftpError,
		int	percentComplete,
		String []	dirList
	)

Invoked to update the progress on previously initiated RFTP transfer.

File I/O is taken care of in native code.

Parameters

id	identifies the RCPCamera object
uuid	byte array containing the UUID. Same format as rcp_uuid_t
rftpType	indicates what type of command this was (e.g. store). See rftp_types_t
rftpError	Error code. See rftp_error_t
percentComplete	Applicable to STORE and RETRIEVE. From 0 - 100
dirList	Applicable to LIST command. Array of strings that contains the results of the listing.

Implemented in com.red.rcp.RCPCamera.

---

The documentation for this interface was generated from the following file:

• RCPCameraListener.java