API Reference

• Simple API
  • Device
    • Device.battery_level_percent
    • Device.battery_state
    • Device.close()
    • Device.estimate_time_offset()
    • Device.gaze_sensor()
    • Device.get_calibration()
    • Device.get_errors()
    • Device.get_template()
    • Device.get_template_data()
    • Device.is_currently_streaming
    • Device.memory_num_free_bytes
    • Device.memory_state
    • Device.module_serial
    • Device.phone_id
    • Device.phone_ip
    • Device.phone_name
    • Device.post_template_data()
    • Device.receive_eyes_video_frame()
    • Device.receive_gaze_datum()
    • Device.receive_imu_datum()
    • Device.receive_matched_scene_and_eyes_video_frames_and_gaze()
    • Device.receive_matched_scene_video_frame_and_gaze()
    • Device.receive_scene_video_frame()
    • Device.recording_cancel()
    • Device.recording_start()
    • Device.recording_stop_and_save()
    • Device.send_event()
    • Device.serial_number_glasses
    • Device.serial_number_scene_cam
    • Device.start_stream_if_needed()
    • Device.streaming_start()
    • Device.streaming_stop()
    • Device.version_glasses
    • Device.world_sensor()
  • MatchedGazeEyesSceneItem
  • MatchedItem
  • SimpleVideoFrame
    • SimpleVideoFrame.datetime
    • SimpleVideoFrame.from_video_frame()
    • SimpleVideoFrame.timestamp_unix_ns
  • discover_devices()
  • discover_one_device()
• Asynchonous API
  • Device Discovery
    • Network
      • Network.close()
      • Network.devices
      • Network.wait_for_new_device()
    • discover_devices()
    • is_valid_service_name()
  • Remote Control
    • Device
      • Device.close()
      • Device.get_calibration()
      • Device.get_status()
      • Device.get_template()
      • Device.get_template_data()
      • Device.post_template_data()
      • Device.recording_cancel()
      • Device.recording_start()
      • Device.recording_stop_and_save()
      • Device.send_event()
      • Device.status_updates()
    • DeviceError
    • StatusUpdateNotifier
      • StatusUpdateNotifier.receive_updates_start()
      • StatusUpdateNotifier.receive_updates_stop()
    • UpdateCallback
    • UpdateCallbackAsync
    • UpdateCallbackSync
  • Streaming
    • Gaze Data
      • EyestateEyelidGazeData
        • EyestateEyelidGazeData.datetime
        • EyestateEyelidGazeData.from_raw()
        • EyestateEyelidGazeData.timestamp_unix_ns
      • EyestateGazeData
        • EyestateGazeData.datetime
        • EyestateGazeData.from_raw()
        • EyestateGazeData.timestamp_unix_ns
      • GazeData
        • GazeData.datetime
        • GazeData.from_raw()
        • GazeData.timestamp_unix_ns
      • Point
      • RTSPGazeStreamer
        • RTSPGazeStreamer.receive()
      • receive_gaze_data()
    • IMU Data
      • Data3D
      • IMUData
        • IMUData.datetime
        • IMUData.timestamp_unix_nanoseconds
        • IMUData.timestamp_unix_ns
      • IMUPacket_to_IMUData()
      • Quaternion
      • RTSPImuStreamer
        • RTSPImuStreamer.receive()
      • receive_imu_data()
    • Eye Events
      • BlinkEventData
        • BlinkEventData.datetime
        • BlinkEventData.from_raw()
        • BlinkEventData.timestamp_unix_ns
      • FixationEventData
        • FixationEventData.datetime
        • FixationEventData.from_raw()
        • FixationEventData.timestamp_unix_ns
      • FixationOnsetEventData
        • FixationOnsetEventData.datetime
        • FixationOnsetEventData.from_raw()
        • FixationOnsetEventData.timestamp_unix_ns
      • RTSPEyeEventStreamer
        • RTSPEyeEventStreamer.receive()
      • receive_eye_events_data()
    • Scene Video
      • BGRBuffer
      • RTSPVideoFrameStreamer
        • RTSPVideoFrameStreamer.receive()
        • RTSPVideoFrameStreamer.sprop_parameter_set_payloads
      • VideoFrame
        • VideoFrame.bgr_buffer()
        • VideoFrame.datetime
        • VideoFrame.timestamp_unix_ns
        • VideoFrame.to_ndarray()
      • receive_video_frames()
      • extract_payload_from_nal_unit()
    • Raw RTSP Data
      • RTSPData
        • RTSPData._asdict()
        • RTSPData._field_defaults
        • RTSPData._fields
        • RTSPData._make()
        • RTSPData._replace()
        • RTSPData.datetime
        • RTSPData.timestamp_unix_ns
      • RTSPRawStreamer
        • RTSPRawStreamer.encoding
        • RTSPRawStreamer.reader
        • RTSPRawStreamer.receive()
      • SDPDataNotAvailableError
      • _UnknownClockoffsetError
      • _WallclockRTSPReader
        • _WallclockRTSPReader._calculate_clock_offset()
        • _WallclockRTSPReader.absolute_timestamp_from_packet()
        • _WallclockRTSPReader.get_primary_media()
        • _WallclockRTSPReader.get_rtpmap()
        • _WallclockRTSPReader.handle_rtcp()
        • _WallclockRTSPReader.relative_timestamp_from_packet()
      • receive_raw_rtsp_data()
  • Time Echo Protocol
    • Estimate
      • Estimate.mean
      • Estimate.median
      • Estimate.std
    • TimeEcho
    • TimeEchoEstimates
    • TimeFunction
    • TimeOffsetEstimator
      • TimeOffsetEstimator.estimate()
      • TimeOffsetEstimator.request_time_echo()
    • time_ms()
• Model Classes
  • APIPath
    • APIPath.CALIBRATION
    • APIPath.EVENT
    • APIPath.RECORDING_CANCEL
    • APIPath.RECORDING_START
    • APIPath.RECORDING_STOP_AND_SAVE
    • APIPath.STATUS
    • APIPath.TEMPLATE_DATA
    • APIPath.TEMPLATE_DEFINITION
    • APIPath.full_address()
  • Component
  • ComponentRaw
  • DiscoveredDeviceInfo
  • Event
    • Event.datetime
    • Event.from_dict()
  • Hardware
  • InvalidTemplateAnswersError
  • NetworkDevice
  • Phone
  • Recording
    • Recording.rec_duration_seconds
  • Sensor
    • Sensor.Connection
      • Sensor.Connection.ANY
      • Sensor.Connection.DIRECT
      • Sensor.Connection.WEBSOCKET
    • Sensor.Name
      • Sensor.Name.ANY
      • Sensor.Name.EYES
      • Sensor.Name.EYE_EVENTS
      • Sensor.Name.GAZE
      • Sensor.Name.IMU
      • Sensor.Name.WORLD
    • Sensor.url
  • Status
    • Status.direct_eye_events_sensor()
    • Status.direct_eyes_sensor()
    • Status.direct_gaze_sensor()
    • Status.direct_imu_sensor()
    • Status.direct_world_sensor()
    • Status.from_dict()
    • Status.hardware
    • Status.matching_sensors()
    • Status.phone
    • Status.recording
    • Status.sensors
    • Status.update()
  • Template
    • Template.archived_at
    • Template.convert_from_api_to_simple_format()
    • Template.convert_from_simple_to_api_format()
    • Template.created_at
    • Template.description
    • Template.get_question_by_id()
    • Template.id
    • Template.is_default_template
    • Template.items
    • Template.label_ids
    • Template.name
    • Template.published_at
    • Template.recording_ids
    • Template.recording_name_format
    • Template.updated_at
    • Template.validate_answers()
  • TemplateItem
    • TemplateItem.choices
    • TemplateItem.help_text
    • TemplateItem.id
    • TemplateItem.input_type
    • TemplateItem.required
    • TemplateItem.title
    • TemplateItem.validate_answer()
    • TemplateItem.widget_type
  • UnknownComponentError
  • allow_empty()
  • make_template_answer_model_base()
  • not_empty()
  • option_in_allowed_values()
  • parse_component()
• Base Classes
  • DeviceBase
    • DeviceBase.address
    • DeviceBase.api_url()
    • DeviceBase.convert_from()
    • DeviceBase.dns_name
    • DeviceBase.from_discovered_device()
    • DeviceBase.full_name
    • DeviceBase.port
  • DeviceType