TIM SDK
TIM API C
screenshot_information.h File Reference

Description

Screenshot information.

Object type screenshot_information.

Functions

ta_e_result_code_t ta_screenshot_information_get_image_file_format (ta_object_t info, ta_e_image_file_format_t *image_file_format)
 File format of image data. More...
 
ta_e_result_code_t ta_screenshot_information_get_image_width (ta_object_t info, int *image_width)
 Image width in pixels. More...
 
ta_e_result_code_t ta_screenshot_information_get_image_height (ta_object_t info, int *image_height)
 Image height in pixels. More...
 
ta_e_result_code_t ta_screenshot_information_get_image_data (ta_object_t info, ta_object_t *image_data)
 Image data. More...
 

Function Documentation

◆ ta_screenshot_information_get_image_data()

ta_e_result_code_t ta_screenshot_information_get_image_data ( ta_object_t  info,
ta_object_t image_data 
)

Image data.

See ta_string_get_length for the size of the data and ta_string_get_pointer to get access to the data. Data can contain 0-bytes so always use the string length.

Parameters
[in]infoObject instance of type screenshot_information.
[out]image_dataPointer to variable to write object instance to. Object instance is of type string and is not retained.
Return values
ta_c_rc_okObject instance written to image_data.
ta_c_rc_invalid_argumentinfo is ta_object_invalid.
ta_c_rc_invalid_argumentinfo is not of type screenshot_information.
ta_c_rc_invalid_argumentimage_data is null-pointer.

◆ ta_screenshot_information_get_image_file_format()

ta_e_result_code_t ta_screenshot_information_get_image_file_format ( ta_object_t  info,
ta_e_image_file_format_t image_file_format 
)

File format of image data.

Parameters
[in]infoObject instance of type screenshot_information.
[out]image_file_formatPointer to variable to write value to.
Return values
ta_c_rc_okObject instance written to image_file_format.
ta_c_rc_invalid_argumentinfo is ta_object_invalid.
ta_c_rc_invalid_argumentinfo is not of type screenshot_information.
ta_c_rc_invalid_argumentimage_file_format is null-pointer.

◆ ta_screenshot_information_get_image_height()

ta_e_result_code_t ta_screenshot_information_get_image_height ( ta_object_t  info,
int *  image_height 
)

Image height in pixels.

Parameters
[in]infoObject instance of type screenshot_information.
[out]image_heightPointer to variable to write value to.
Return values
ta_c_rc_okObject instance written to image_height.
ta_c_rc_invalid_argumentinfo is ta_object_invalid.
ta_c_rc_invalid_argumentinfo is not of type screenshot_information.
ta_c_rc_invalid_argumentimage_height is null-pointer.

◆ ta_screenshot_information_get_image_width()

ta_e_result_code_t ta_screenshot_information_get_image_width ( ta_object_t  info,
int *  image_width 
)

Image width in pixels.

Parameters
[in]infoObject instance of type screenshot_information.
[out]image_widthPointer to variable to write value to.
Return values
ta_c_rc_okObject instance written to image_width.
ta_c_rc_invalid_argumentinfo is ta_object_invalid.
ta_c_rc_invalid_argumentinfo is not of type screenshot_information.
ta_c_rc_invalid_argumentimage_width is null-pointer.