API Reference

• Simple API
  • Device
    • Device.battery_level_percent
    • Device.battery_state
    • Device.close()
    • Device.estimate_time_offset()
    • Device.gaze_sensor()
    • 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.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.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_status()
      • 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
      • GazeData
        • GazeData.datetime
        • GazeData.from_raw()
        • GazeData.timestamp_unix_ns
      • Point
      • RTSPGazeStreamer
        • RTSPGazeStreamer.receive()
      • receive_gaze_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.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.EVENT
    • APIPath.RECORDING_CANCEL
    • APIPath.RECORDING_START
    • APIPath.RECORDING_STOP_AND_SAVE
    • APIPath.STATUS
    • APIPath.full_address()
  • Component
  • ComponentRaw
  • DiscoveredDeviceInfo
  • Event
    • Event.datetime
    • Event.from_dict()
  • Hardware
  • 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.GAZE
      • Sensor.Name.IMU
      • Sensor.Name.WORLD
    • Sensor.url
  • Status
    • 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()
  • UnknownComponentError
  • 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