Skyle_SkyleProvider

public protocol Skyle_SkyleProvider : CallHandlerProvider

Skyle service to use the eye tracker

To build a server, implement a class that conforms to this protocol.

  • Undocumented

    Declaration

    Swift

    var interceptors: Skyle_SkyleServerInterceptorFactoryProtocol? { get }

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

    Declaration

    Swift

    func calibrate(context: StreamingResponseCallContext<Skyle_CalibMessages>) -> EventLoopFuture<(StreamEvent<Skyle_CalibControlMessages>) -> Void>

  • 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, context: StreamingResponseCallContext<Skyle_PositioningMessage>) -> EventLoopFuture<GRPCStatus>

  • 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, context: StreamingResponseCallContext<Skyle_Types_Point>) -> EventLoopFuture<GRPCStatus>

  • 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, context: StreamingResponseCallContext<Skyle_TriggerMessage>) -> EventLoopFuture<GRPCStatus>

  • Unary call to get the button status

    Declaration

    Swift

    func getButton(request: SwiftProtobuf.Google_Protobuf_Empty, context: StatusOnlyCallContext) -> EventLoopFuture<Skyle_Button>

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

    Declaration

    Swift

    func setButton(request: Skyle_ButtonActions, context: StatusOnlyCallContext) -> EventLoopFuture<Skyle_ButtonActions>

  • 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, context: StatusOnlyCallContext) -> EventLoopFuture<Skyle_Options>

  • Undocumented

    Declaration

    Swift

    func configureStream(context: StreamingResponseCallContext<Skyle_Options>) -> EventLoopFuture<(StreamEvent<Skyle_OptionMessage>) -> Void>

  • Unary call to get software versions

    Declaration

    Swift

    func getVersions(request: SwiftProtobuf.Google_Protobuf_Empty, context: StatusOnlyCallContext) -> EventLoopFuture<Skyle_DeviceVersions>

  • 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, context: StreamingResponseCallContext<Skyle_Profile>) -> EventLoopFuture<GRPCStatus>

  • Unary call to get the current profile

    Declaration

    Swift

    func currentProfile(request: SwiftProtobuf.Google_Protobuf_Empty, context: StatusOnlyCallContext) -> EventLoopFuture<Skyle_Profile>

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

    Declaration

    Swift

    func setProfile(request: Skyle_Profile, context: StatusOnlyCallContext) -> EventLoopFuture<Skyle_StatusMessage>

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

    Declaration

    Swift

    func deleteProfile(request: Skyle_Profile, context: StatusOnlyCallContext) -> EventLoopFuture<Skyle_StatusMessage>

  • Unary call to reset specific parts

    Declaration

    Swift

    func reset(request: Skyle_ResetMessage, context: StatusOnlyCallContext) -> EventLoopFuture<Skyle_StatusMessage>

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

    Declaration

    Swift

    func cursorCalibration(context: StreamingResponseCallContext<Skyle_Types_Point>) -> EventLoopFuture<(StreamEvent<Skyle_CalibCursorMessages>) -> Void>

  • 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, context: StreamingResponseCallContext<Skyle_RawImage>) -> EventLoopFuture<GRPCStatus>

  • 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, context: StreamingResponseCallContext<Skyle_BinocularGaze>) -> EventLoopFuture<GRPCStatus>
  • serviceName Extension method

    Declaration

    Swift

    public var serviceName: Substring { get }
  • handle(method:context:) Extension method

    Determines, calls and returns the appropriate request handler, depending on the request’s method. Returns nil for methods not handled by this service.

    Declaration

    Swift

    public func handle(
  method name: Substring,
  context: CallHandlerContext
) -> GRPCServerHandlerProtocol?