/AWS1/IF_IOS=>GETCAPTUREDATA()

About GetCaptureData

Retrieves video data for a specific time range.

Method Signature

METHODS /AWS1/IF_IOS~GETCAPTUREDATA
  IMPORTING
    !IV_WORKSPACENAME TYPE /AWS1/IOSWORKSPACENAME OPTIONAL
    !IO_STARTTIME TYPE REF TO /AWS1/CL_IOSTIMEINNANOS OPTIONAL
    !IO_ENDTIME TYPE REF TO /AWS1/CL_IOSTIMEINNANOS OPTIONAL
    !IV_TIMESERIESID TYPE /AWS1/IOSTIMESERIESID OPTIONAL
    !IV_PROPERTYALIAS TYPE /AWS1/IOSASSETPROPERTYALIAS OPTIONAL
    !IO_FORMATSETTINGS TYPE REF TO /AWS1/CL_IOSFORMATSETTINGS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/IOSGETCAPTDATANEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_iosgetcapturedatarsp
  RAISING
    /AWS1/CX_IOSACCESSDENIEDEX
    /AWS1/CX_IOSINTERNALFAILUREEX
    /AWS1/CX_IOSINVALIDREQUESTEX
    /AWS1/CX_IOSRESOURCENOTFOUNDEX
    /AWS1/CX_IOSTHROTTLINGEX
    /AWS1/CX_IOSCLIENTEXC
    /AWS1/CX_IOSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_workspacename TYPE /AWS1/IOSWORKSPACENAME /AWS1/IOSWORKSPACENAME

The name of the workspace that contains the capture source.

io_starttime TYPE REF TO /AWS1/CL_IOSTIMEINNANOS /AWS1/CL_IOSTIMEINNANOS

The start time for the video data range.

io_endtime TYPE REF TO /AWS1/CL_IOSTIMEINNANOS /AWS1/CL_IOSTIMEINNANOS

The end time for the video data range. Must be greater than startTime.

Optional arguments:

iv_timeseriesid TYPE /AWS1/IOSTIMESERIESID /AWS1/IOSTIMESERIESID

The time series ID that identifies the capture source. Mutually exclusive with propertyAlias.

iv_propertyalias TYPE /AWS1/IOSASSETPROPERTYALIAS /AWS1/IOSASSETPROPERTYALIAS

The property alias that identifies the capture source. Mutually exclusive with timeSeriesId.

io_formatsettings TYPE REF TO /AWS1/CL_IOSFORMATSETTINGS /AWS1/CL_IOSFORMATSETTINGS

The optional format settings for the output.

iv_nexttoken TYPE /AWS1/IOSGETCAPTDATANEXTTOKEN /AWS1/IOSGETCAPTDATANEXTTOKEN

The token from a previous response used to continue retrieving data.

RETURNING

oo_output TYPE REF TO /aws1/cl_iosgetcapturedatarsp /AWS1/CL_IOSGETCAPTUREDATARSP

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->getcapturedata(
  io_endtime = new /aws1/cl_iostimeinnanos(
    iv_offsetinnanos = 123
    iv_timeinseconds = 123
  )
  io_formatsettings = new /aws1/cl_iosformatsettings(
    iv_framespersecond = 123
    iv_heightinpixels = 123
    iv_widthinpixels = 123
  )
  io_starttime = new /aws1/cl_iostimeinnanos(
    iv_offsetinnanos = 123
    iv_timeinseconds = 123
  )
  iv_nexttoken = |string|
  iv_propertyalias = |string|
  iv_timeseriesid = |string|
  iv_workspacename = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_captureblob = lo_result->get_data( ).
  lo_timeinnanos = lo_result->get_starttime( ).
  IF lo_timeinnanos IS NOT INITIAL.
    lv_timeinseconds = lo_timeinnanos->get_timeinseconds( ).
    lv_offsetinnanos = lo_timeinnanos->get_offsetinnanos( ).
  ENDIF.
  lo_timeinnanos = lo_result->get_endtime( ).
  IF lo_timeinnanos IS NOT INITIAL.
    lv_timeinseconds = lo_timeinnanos->get_timeinseconds( ).
    lv_offsetinnanos = lo_timeinnanos->get_offsetinnanos( ).
  ENDIF.
  lv_videodatatype = lo_result->get_datatype( ).
  lv_getcapturedatanexttoken = lo_result->get_nexttoken( ).
ENDIF.