XPSDKVideoConnection

@interface XPSDKVideoConnection : NSObject

This class manages an established connection and handles receiving and parsing frames. Do not create instances of that class directly. Instead call XPMobileSDK.requestStream to first prepare the connection to the camera. In the callback you will receive instance of the prepared VideoConnection object ready to be opened. Then set an observer object to receive frames, events and etc and just open the connection. Video connections cannot be reused. Once closed it cannot be reopened.

  • Video ID of the video connection. Use that to send commands over the meta connection

    Declaration

    Objective-C

    XPSDKVideoID videoID

  • Each video connection keeps an instance of the main commands connection so it can send close and etc commands if needed and to update the network indicator

    Declaration

    Objective-C

    XPSDKConnection *metaConnection

  • Flag - set to YES if finished

    Declaration

    Objective-C

    BOOL finished

  • The video connection delegate

    Declaration

    Objective-C

    id<XPSDKVideoConnectionDelegate> delegate

  • Video ID of the video connection. Use that to send commands over the meta connection

    Declaration

    Objective-C

    @property (readonly, nonatomic) XPSDKVideoID videoID;

  • Each video connection keeps an instance of the main commands connection so it can send close and etc commands if needed and to update the network indicator

    Declaration

    Objective-C

    @property (readonly, nonatomic) XPSDKConnection *metaConnection;

  • Set to YES if the video connection has been started

    Declaration

    Objective-C

    @property (readonly, getter=isOpened, nonatomic) int opened;

  • Delegate of the video connection

    Declaration

    Objective-C

    @property (readwrite, nonatomic) id<XPSDKVideoConnectionDelegate> delegate;

  • Method of the video connection

    Declaration

    Objective-C

    @property (readonly, nonatomic) XPSDKVideoConnectionMethod method;

  • Designated initializer. Instances should only ne created by the main connection!

    Declaration

    Objective-C

    - (id)initFromControlConnection:(XPSDKConnection *)mainConnection
                        videoID:(XPSDKVideoID)vid;

    Parameters

    mainConnection

    the main connection from which the video connection is derived.
    vid

    Video ID

Methods for instance variable 'finished'

  • Closes the connection to the video server.

    Should be implemented by the subclasses.

    Declaration

    Objective-C

    - (void)close;