Usage Examples - iOS - MobileTimelineSDK

Features

  1. For instantiating the TimelineSDK, accessToken and cameraId is the required parameters, while all other parameters are optional
  2. The default value for isTimelineControlsVisible and isVerticalRecordingsVisible is true, which means by default the vertical recording bar and the bottom tab bar will be visible. We can hide it by setting these bool values as false.
  3. The TimelineSDK provides 3 levels of zoom from 0 to 2. 0 is the lowest zoom level that means No zoom and 2 is the maximum zoom level.
  4. In the most zoomed-in state, there will be three dots icon visible for each event. Users will be able to Download and Share through the three-dot menu.
  5. User can set the Primary and Secondary color in Hex string form. Eg: "#0c94c8" By default it will show the camera manager’s primary and secondary color i.e. primaryColor = @"#0c94c8" and secondaryColor = @"#333333".
  6. The SDK supports localizations, it will select the device language. The default language is English.
  7. The SDK supports Poppins and Default (Roboto) font. User can set the font while instantiating the SDK by settings customFont parameter. Eg: timelineObj.customFont = poppinsFont.
  8. The SDK supports hiding specific event types. Eg: timelineObj.hideEventTypes = @"vmdDetected,pirDetected"
  9. Camera name can be hidden. Eg: timelineObj.isCameraNameVisible = NO;

Instantiation

Objective-C Example  Expand source
Swift Example  Expand source

Parameters

Parameter

Data Type

Description

Is Required

accessToken

String

Access Token required to passed for Authentication/authorization

true

cameraId

Int

Camera Id to identify Camera

true

startTime

Date

Start time for laoding events and recordings.

Default value : Most recent date and time.

primaryColor

String

Takes hex value of color as string.

Eg:timelineObj.primaryColor = "#0c94c8";

secondaryColor 

String

Takes hex value of color as string.

Eg:timelineObj.secondaryColor = "#333333";

customFont

FontType (enum)

Allows user to select default or poppins font. The dafault font is Roboto.

Available font types:

poppinsFont, defaultFont

Eg:timelineObj.customFont = poppinsFont;

Default Font value: defaultFont

isTimelineControlsVisible

Bool

Set True/False to Show/Hide the bottom tab bar control on timeline screen.

Eg: timelineObj.isTimelineControlsVisible = true;

Default value: True

isVerticalRecordingsVisible

Bool

Set True/False to Show/Hide the vertical timeline recordings.

Eg:timelineObj.isVerticalRecordingsVisible = false;

Default value: True

zoomLevel

Int

Set the value from 0 to 2 to set the Zoom level, where 0 is No-zoom and 2 is the highest zoom level.

Default value: 0 (No zoom)

albumName

String

To specify the album name for saving the Snapshots and downloaded events.

Default album name is: Timeline

hideEventTypes String

String of event types to hide (comma-separated).

Eg: timelineObject.hideEventTypes = "vmdDetected,pirDetected"

  

isCameraNameVisible

 Bool

Allows the user to hide Camera name.

Default value: True

  


Initialize the SDK

Example Eagle Eye CMMobileTimelineSDK initialization

Authentication/Authorization

Set initialization parameter accessToken.

Select Camera

Set initialization parameter cameraId.

Set Date-Time

Set initialization parameter time with seconds. - timestamp.

Set Zoom Level

Available zoom levels are 0,1,2. Default = 0

Set Colors

The default colors are primaryColor = "#0c94c8" and secondaryColor  = "#333333"

Set Font Family

Available font families are Roboto and Poppins.

Hide Bottom Tab Bar GUI Component

Hide Vertical Recording Line GUI Component

Hide Specific Event Types

Hide Camera Name

Localization

Device language will be set by the SDK. Supported languages are English, Dutch, German, Spanish, Turkish. For unsupported language, the default language is English.