Skyle_SkyleClientProtocol

public protocol Skyle_SkyleClientProtocol : GRPCClient

Skyle service to use the eye tracker

Usage: instantiate Skyle_SkyleClient, then call methods of this protocol to make API calls.

  • serviceName Default implementation

    Undocumented

    Default Implementation

    Undocumented

    Declaration

    Swift

    var serviceName: String { get }

  • Undocumented

    Declaration

    Swift

    var interceptors: Skyle_SkyleClientInterceptorFactoryProtocol? { get }
  • calibrate(callOptions:handler:) Default implementation

    Undocumented

    Default Implementation

    Used to calibrate for the current user. Streams in both directions with given message types. Client needs to close the stream when done

    Callers should use the send method on the returned object to send messages to the server. The caller should send an .end after the final message has been sent.

    Declaration

    Swift

    func calibrate(
  callOptions: CallOptions?,
  handler: @escaping (Skyle_CalibMessages) -> Void
) -> BidirectionalStreamingCall<Skyle_CalibControlMessages, Skyle_CalibMessages>
  • positioning(_:callOptions:handler:) Default implementation

    Undocumented

    Default Implementation

    Subscribe a stream sending eye positions and quality indicators to achieve good positioning of a user. Client needs to close the stream when done

    Declaration

    Swift

    func positioning(
  _ request: SwiftProtobuf.Google_Protobuf_Empty,
  callOptions: CallOptions?,
  handler: @escaping (Skyle_PositioningMessage) -> Void
) -> ServerStreamingCall<SwiftProtobuf.Google_Protobuf_Empty, Skyle_PositioningMessage>
  • gaze(_:callOptions:handler:) Default implementation

    Undocumented

    Default Implementation

    Subscribe a gaze stream, that sends coordinates of the current user gaze on a screen. Client needs to close the stream when done

    Declaration

    Swift

    func gaze(
  _ request: SwiftProtobuf.Google_Protobuf_Empty,
  callOptions: CallOptions?,
  handler: @escaping (Skyle_Types_Point) -> Void
) -> ServerStreamingCall<SwiftProtobuf.Google_Protobuf_Empty, Skyle_Types_Point>
  • trigger(_:callOptions:handler:) Default implementation

    Undocumented

    Default Implementation

    Subscribe a trigger stream, that sends trigger messages, when a user fixates a point or clicks. Client needs to close the stream when done

    Declaration

    Swift

    func trigger(
  _ request: SwiftProtobuf.Google_Protobuf_Empty,
  callOptions: CallOptions?,
  handler: @escaping (Skyle_TriggerMessage) -> Void
) -> ServerStreamingCall<SwiftProtobuf.Google_Protobuf_Empty, Skyle_TriggerMessage>
  • getButton(_:callOptions:) Default implementation

    Undocumented

    Default Implementation

    Unary call to get the button status

    Declaration

    Swift

    func getButton(
  _ request: SwiftProtobuf.Google_Protobuf_Empty,
  callOptions: CallOptions?
) -> UnaryCall<SwiftProtobuf.Google_Protobuf_Empty, Skyle_Button>
  • setButton(_:callOptions:) Default implementation

    Undocumented

    Default Implementation

    Unary call to configure the button actions, answers with the resulting configuration

    Declaration

    Swift

    func setButton(
  _ request: Skyle_ButtonActions,
  callOptions: CallOptions?
) -> UnaryCall<Skyle_ButtonActions, Skyle_ButtonActions>
  • configure(_:callOptions:) Default implementation

    Undocumented

    Default Implementation

    Unary call to get (OptionMessage -> empty) or set options (OptionMessage -> Options). Answers with the resulting options. Options are saved to the current user profile

    Declaration

    Swift

    func configure(
  _ request: Skyle_OptionMessage,
  callOptions: CallOptions?
) -> UnaryCall<Skyle_OptionMessage, Skyle_Options>
  • configureStream(callOptions:handler:) Default implementation

    Undocumented

    Default Implementation

    Bidirectional streaming call to ConfigureStream

    Callers should use the send method on the returned object to send messages to the server. The caller should send an .end after the final message has been sent.

    Declaration

    Swift

    func configureStream(
  callOptions: CallOptions?,
  handler: @escaping (Skyle_Options) -> Void
) -> BidirectionalStreamingCall<Skyle_OptionMessage, Skyle_Options>
  • getVersions(_:callOptions:) Default implementation

    Undocumented

    Default Implementation

    Unary call to get software versions

    Declaration

    Swift

    func getVersions(
  _ request: SwiftProtobuf.Google_Protobuf_Empty,
  callOptions: CallOptions?
) -> UnaryCall<SwiftProtobuf.Google_Protobuf_Empty, Skyle_DeviceVersions>
  • getProfiles(_:callOptions:handler:) Default implementation

    Undocumented

    Default Implementation

    Subscribe a profile stream of all available profiles. Host ends stream when all results are sent

    Declaration

    Swift

    func getProfiles(
  _ request: SwiftProtobuf.Google_Protobuf_Empty,
  callOptions: CallOptions?,
  handler: @escaping (Skyle_Profile) -> Void
) -> ServerStreamingCall<SwiftProtobuf.Google_Protobuf_Empty, Skyle_Profile>
  • currentProfile(_:callOptions:) Default implementation

    Undocumented

    Default Implementation

    Unary call to get the current profile

    Declaration

    Swift

    func currentProfile(
  _ request: SwiftProtobuf.Google_Protobuf_Empty,
  callOptions: CallOptions?
) -> UnaryCall<SwiftProtobuf.Google_Protobuf_Empty, Skyle_Profile>
  • setProfile(_:callOptions:) Default implementation

    Undocumented

    Default Implementation

    Unary call to set or create a profile. Answers with a status message (success or failure)

    Declaration

    Swift

    func setProfile(
  _ request: Skyle_Profile,
  callOptions: CallOptions?
) -> UnaryCall<Skyle_Profile, Skyle_StatusMessage>
  • deleteProfile(_:callOptions:) Default implementation

    Undocumented

    Default Implementation

    Unary call to delete a profile. Answers with a status message (success or failure)

    Declaration

    Swift

    func deleteProfile(
  _ request: Skyle_Profile,
  callOptions: CallOptions?
) -> UnaryCall<Skyle_Profile, Skyle_StatusMessage>
  • reset(_:callOptions:) Default implementation

    Undocumented

    Default Implementation

    Unary call to reset specific parts

    Declaration

    Swift

    func reset(
  _ request: Skyle_ResetMessage,
  callOptions: CallOptions?
) -> UnaryCall<Skyle_ResetMessage, Skyle_StatusMessage>

  • Undocumented

    Default Implementation

    Used to calibrate / test cursor. Streams in both directions with given message types. Client needs to close the stream when done

    Callers should use the send method on the returned object to send messages to the server. The caller should send an .end after the final message has been sent.

    Declaration

    Swift

    func cursorCalibration(
  callOptions: CallOptions?,
  handler: @escaping (Skyle_Types_Point) -> Void
) -> BidirectionalStreamingCall<Skyle_CalibCursorMessages, Skyle_Types_Point>
  • rawImages(_:callOptions:handler:) Default implementation

    Undocumented

    Default Implementation

    Subscribe a raw image stream that sends unencoded frames. Client needs to close the stream when done

    Declaration

    Swift

    func rawImages(
  _ request: SwiftProtobuf.Google_Protobuf_Empty,
  callOptions: CallOptions?,
  handler: @escaping (Skyle_RawImage) -> Void
) -> ServerStreamingCall<SwiftProtobuf.Google_Protobuf_Empty, Skyle_RawImage>

  • Undocumented

    Default Implementation

    Subscribe a unfiltered binocular gaze stream, that sends coordinates of the current user gaze per eye. Client needs to close the stream when done

    Declaration

    Swift

    func rawBinocularGaze(
  _ request: SwiftProtobuf.Google_Protobuf_Empty,
  callOptions: CallOptions?,
  handler: @escaping (Skyle_BinocularGaze) -> Void
) -> ServerStreamingCall<SwiftProtobuf.Google_Protobuf_Empty, Skyle_BinocularGaze>