SOSScreenAnnotations

@interface SOSScreenAnnotations : NSObject

Class to handle screen annotations. This class implements the SOSWebRTCDelegate.

  • If enabled, will allow drawing on the current screen by the service agent.

    Default: YES

    Note

    if you set this to NO while screen sharing is active, it will execute -stop.

    Declaration

    Objective-C

    @property (assign, readwrite, atomic) BOOL enabled;

    Swift

    var enabled: Bool { get set }

  • When enabled all touch events will clear the screen of annotations, unless the Agent is currently drawing.
    If you wish to handle clearing annotations yourself set this to NO.

    Default: YES

    Declaration

    Objective-C

    @property (assign, readwrite, atomic) BOOL clearOnTouches;

    Swift

    var clearOnTouches: Bool { get set }

  • Customizable color of the line drawing feature. Will not change the color of existing lines on the screen.

    Default: [UIColor redColor]

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) UIColor *lineColor;

    Swift

    var lineColor: UIColor! { get set }

  • Customizable width of the line drawing feature. Does not change the width of existing lines on the screen.

    Default: 5.0f

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) CGFloat lineWidth;

    Swift

    var lineWidth: CGFloat { get set }

  • Clears the current annotation by reinitializing the drawer.

    Declaration

    Objective-C

    - (void)clearDraw;

    Swift

    func clearDraw()

  • Initiates the drawing feature.

    Declaration

    Objective-C

    - (void)start;

    Swift

    func start()

  • Stops the drawing feature.

    Declaration

    Objective-C

    - (void)stop;

    Swift

    func stop()