Lesson 1: Data Model 101

Skylark boasts a highly adaptable and scalable data model architecture that empowers users to construct their ideal framework from scratch, encompassing a wide array of custom fields, objects and relationships.

To help customers get up to speed quickly, Skylark ships with a pre-configured data model optimised for entertainment-related applications, which is detailed below. This data model is also fully customisable, allowing for the integration of additional custom fields, object types and relationships to meet any desired use case and specification.

Included Object Types

The built-in Skylark data model has the following default object types:

• Brand
• Season
• Episode
• Movie
• Genre
• Theme
• ParentalGuidance
• Rating
• Person
• Credit
• Role

These object types can be updated to suit your needs, and new object types can be added via the self-configuration API.

Special Objects

The built-in data model also includes these special, proprietary object types. New fields can still be added to these object types, but due to the functionality these types support, the type itself cannot be removed.

• SkylarkAsset: An asset represents a video asset
• SkylarkImage: An image can be related to any other object type
• TextTrack: This contains information regarding subtitles
• AudioTrack: This contains audio information including codec, bitrate and channels
• VideoTrack: This contains video information including codec, bitrate etc
• ProviderCredential: This contains information regarding OVP credentials
• PlaybackProvider: This contains information regarding a given OVP provider
• PlaybackDetail: This contains details regarding playback information
• PlaybackDetailAttribute: This contains extra information regarding playback
• SkylarkTag: A tag is a value that can be related to any other object type
• SkylarkSet: A set is a collection of objects which can be used for homepages, rails, etc
• SkylarkChannel: Contains information relating to live video playback
• SkylarkEPGProgram: Contains information relating to live video playback

Included Enums

Enums are a way of limiting input to a predefined set of options. Skylark includes the following enums built in for setting an object's type.

• ImageType (with values: MAIN, HEADER, FOOTER, BACKGROUND, POSTER, LANDSCAPE, PREVIEW, FEATURE, THUMBNAIL, PRE_LIVE, POST_LIVE)
• SetType (with values: PAGE, RAIL, SLIDER, COLLECTION)
• AssetType (with values: MAIN, TRAILER)

The values for these enums can be removed or new values can be added. You can also create entirely new enums.

Special Enums

In the same way as the object types, there are a number of special Enums that cannot be removed.

• VideoFormat: SD, HD, 4K etc
• VideoColour: BW, COLOUR etc
• VideoColourEncoding: PAL, NTSC, HDR10 etc
• VideoColourDepth: SDR or HDR
• TextTrackFormat: SRT, VTT, SCC
• TokenAlgorithm: HS256 or RS256
• PlaybackType: Live or VOD