Classes Reference


                    
                    
                    TraceVision

Main SDK class to get/create various objects and handlers

Use TraceVision.shared to access the singleton to interact with SDK.

Note

The SDK should be initialized with initSDK() method before using any other methods. You will need to provide the API token and secret that you should acquire from TraceVision.

Declaration

Swift

public class TraceVision : ObservableObject


                    
                    
                    AuthInfo

Obsevable information about the authorization

Declaration

Swift

public final class AuthInfo : ObservableObject


                    
                    
                    LimitedQueue

A Queue with a limited capacity backed by the array

When the queue is full, the oldest element is removed from the queue if append is called

Note

the queue is not thread safe

Declaration

Swift

public class LimitedQueue<T> : Sequence


                    
                    
                    HighlightVideoPlayer

Video player that can play a list of highlights

Each HighlightObject should have chunkName pointing to the video file

Declaration

Swift

public final class HighlightVideoPlayer : ObservableObject


                    
                    
                    VideoRenderView

A UIView subclass that displays the video content of an AVPlayer object associated with a HighlightVideoPlayer.

This view contains AVPlayerLayer that is connected to the video player. To initialize the view, you need to provide a HighlightVideoPlayer object or you can set it later with the player property.

Note

uses AVSynchronizedLayer to sync video and animation that is used to follow the player

Declaration

Swift

public class VideoRenderView : UIView


                    
                    
                    VideoStatus

Observable Video status class that provides updates to the processing of the video.

Provides published observable processing status, number of highlights found and the list of the highlights.

Note

We have highlightsFound and highlights as separate properties. Due to the nature of how TraceDetector works these properties can be updated separately and be out of sync during the processing. As soon as the highlight detected the highlightsFound property is updated but the highlight is not available via highlights yet. TraceDetector will continue to track the highlight and then finalize it a little later. Once the highlight is finalized it will be available in the highlights list.

Declaration

Swift

public class VideoStatus : ObservableObject


                    
                    
                    VideoImportStatus

Observable VideoImport status class that provides updates to the processing of the imported video.

Provides progress, estimated time remaining of the processing and a preview frame. This class inherits from VideoStatus and provides the same observable properties for the processing status, number of highlights found and the list of highlights.

Declaration

Swift

public class VideoImportStatus : VideoStatus


                    
                    
                    VideoRecorderStatus

Observable class provides status updates for the video recorder

Properties of this class are updated by the VideoRecorderProtocol methods. Provides the following published observable properties:

isInitialized - is the recorder initialized
isRecording - is the recorder currently recording
duration - duration of the current recording
orientation - current orientation of the video recorder
zoom - current zoom level of the video recorder

Note

You can get the current object from the VideoRecorderProtocol.status prop

Declaration

Swift

public class VideoRecorderStatus : VideoStatus


                    
                    
                    VideoInfo

Video information

Contains the information about the video file, it’s location, duration, video dimensions, etc

Declaration

Swift

public class VideoInfo