Page Comparison

Introduction

Currently, to play the contents we need to pass all the config data to the player. In this config there are some mandatory and options fields. This wiki explains those mandatory and optional fields.

...

The following configuration is required to play the pdf content in player

Context:

Context contains the following properties:

...

Property name

...

Description

...

optional/Required

...

Comment

...

mode

...

To identify preview used by the user to play/edit/preview

...

Optional

...

Can be set it as preview from the player side

...

authToken

...

Auth key to make the api call

...

Optional

...

As we are not calling any api from player side authtoken property can be optional.

...

sid

...

User sessionId

...

Optional

...

Default can be set from player side

...

did

...

Unique id to identify the device

...

Optional

...

Default can be set from player side

...

uid

...

Current logged in user id

...

Optional

...

Default can be set from player side

...

channel

...

Unique id of the channel

...

Optional

...

This can be a optional and can be set it from player side a a default parameter.

...

pdata

...

producer id

...

Optional

...

Default can be set from player

...

contextRollup

...

Defines the content rollup data

...

Optional

...

Its a optional field in telemetry

...

objectRollup

...

Defines the content object data

...

Optional

...

Its a optional field in telemetry

...

Sample context object:

Code Block

{
    "mode": "play",  // To identify preview used by the user to play/edit/preview
    "authToken": "", // Auth key to make  api calls
    "sid": "7283cf2e-d215-9944-b0c5-269489c6fa56", // User sessionid on portal or mobile 
    "did": "3c0a3724311fe944dec5df559cc4e006", // Unique id to identify the device or browser 
    "uid": "anonymous", // Current logged in user id
    "channel": "505c7c48ac6dc1edc9b08f21db5a571d", // Unique id of the channel(Channel ID)
    "pdata": {
      "id": "sunbird.portal", // Producer ID. For ex: For sunbird it would be "portal" or "genie"
      "ver": "3.2.12", // Version of the App
      "pid": "sunbird-portal.contentplayer" // Optional. In case the component is distributed, then which instance of that component
    },
    "contextRollup": { // Defines the content roll up data
      "l1": "505c7c48ac6dc1edc9b08f21db5a571d"
    },
    "tags": [ // Defines the tags data
      ""
    ],
    "cdata": [], // Defines correlation data
    "timeDiff": 0,  // Defines the time difference
    "objectRollup": {}, // Defines the object roll up data
    "host": "", // Defines the from which domain content should be load
    "endpoint": "", // Defines the end point
    "userData": {  // Defines the user data firstname & lastname
      "firstName": "",
      "lastName": ""
    }
  }

...

context(Optional) : Additional data to the content
config (Optional) : Config object data to content play
metadata (Required) : Metadata gives a complete information about the content.

Code Block
pdfPlayerConfig = { context?: Context; config?: Config; metadata: { _metadataObject_ // Some of the metadata fields are required. Mentioned in below 3.Metadata section } }

1. Context (Optional):

Context is an optional property for player config, if we want to send the context - the following table shows what are the fields is required to send the context.

Sample context object interface:

Code Block

{
      mode?: string;
      authToken?: string;
      sid?: string;
      did?: string;
      uid?: string;
      channel: string;
      pdata: Pdata;
      contextRollup?: ContextRollup;
      tags?: string[];
      cdata?: Cdata[];
      timeDiff?: number;
      objectRollup?: ObjectRollup;
      host?: string;
      endpoint?: string;
      dispatcher?: object;
      userData?: {
          firstName?: string;
          lastName?: string;
      };
}

Property name

Description

Optional/Required

Without field

Comment

Default

Code changes required

1

channel

it is an string containing unique channel name.

Required

minLength=1

telemetry validation error

Default can be set from player side. Telemetry sdk will set by default “in.ekstep"

"in.ekstep"

Yes

2

env

It is an string containing Unique environment where the event has occurred

Required

telemetry validation error

Content player set it by default to “contentplayer"

"contentplayer"

No

3

pdata

Producer data. It is an object containing id, version and pid.

Required

Code Block
{ id: "in.ekstep", ver ? : "1.0", pid ? : "" }

telemetry validation error

Default can be set from player side. Telemetry sdk will set by default{ id: "in.ekstep", ver: "1.0", pid: "" }

{ id: "in.ekstep", ver: "1.0", pid: "" }

Yes

4

mode

To identify preview used by the user to play/edit/preview

Optional

"play"

Telemetry sdk will set by default as "play"

"play"

No

5

sid

It is an string containing user session id.

Optional

sid = uid

Telemetry sdk will set by default as "uid"

"uid"

No

6

did

It is an string containing unique device id.

Optional

It will generate from telemetry sdk

Telemetry sdk will set by default using fingerPrintJs

fingerPrintjs2

No

7

uid

It is an string containing user id.

Optional

actor.id = did ? did : "anonymous"

Telemetry sdk will use did as default

"anonymous"

No

8

authToken

It is an string to send telemetry to given endpoint (API uses for authentication)

Optional

show warning in console

Player will set default ""

""

Yes

9

contextRollup

Defines the content rollup data

Optional

{}

Its a optional field in telemetry

{}

No

10

objectRollup

Defines the content object data

Optional

{}

Its a optional field in telemetry

{}

No

11

tags

It is an array. It can be used to tag devices so that summaries/metrics can be derived via specific tags. Helpful during analysis

Optional

[]

Its a optional tags data

[]

No

12

cdata

It is an array. Correlation data. Can be used to correlate multiple events. Generally used to track user flow

Optional

Code Block
[ {"type", "id"}]

[]

This is an optional but - if we are passing the type and id is required.

[]

No

13

host

It is an string containing API endpoint host.

Optional

""

Content Player set it as "" and Telemetry sdk will set by default as “https://api.ekstep.in"

“https://api.ekstep.in“

No

14

endpoint

It defines the endpoint

Optional

""

Content Player set it as “/data/v3/telemetry“

/data/v3/telemetry

No

15

userData

Defines the user first name and last name

Optional

User first and lastname will not show in endpage

Default can be set from player side.

Code Block
{ "firstName": "anoymous","lastName": ""}

Yes

16

dispatcher

Dispatcher is required to receive the player events. .

Optional

The parent will not see the player events.

Code Block
dispatcher: { dispatch(event) { console.log(`Events from dispatcher: ${JSON.stringify(event)}`); } }

""

No

...

2. Config (Optional)

All the configuration can be set by default from player side so this config object can be optional

sample config

...

object interface:

Code Block

"config"?: { 
    "sideMenu"?: { 
      "showShare"?: true,boolen; // show/hide share button in side menu. default value is true
      "showDownload"?: true,boolen; // show/hide download button in side menu. default value is true
      "showReplay"?: true,boolen; // show/hide replay button in side menu. default value is true
      "showExit"?: false,boolen; // show/hide exit button in side menu. default value is false
      "showPrint"?: trueboolen; // show/hide print button in side menu. default value is true
    }
  }

Property name	Description	Optional/Required	Default
`share`	It is `boolen` value to show and hide share button in sidemenu	optional	`true`
`download`	It is `boolen` value to show and hide download button in sidemenu	optional	`true`
`print` (only for pdf, epub)	It is `boolen` value to show and hide print button in sidemenu	optional	`true` (only for pdf, epub is true)
`reply`	It is `boolen` value to show and hide reply button in sidemenu	optional	`false`
`exit`	It is `boolen` value to show and hide exit button in sidemenu	optional	`false`

...

3. Metadata (Required)

Metadata gives a complete information about the content.

Based on the isAvailableLocally property player will be playing the content online or offline.

Sample metadata object interface:

Code Block
"metadata": { "identifier": string; "name": string; "artifactUrl": string; "streamingUrl"?: string; }

In metadata the following properties are mandatory to play the content in ONLINE play.

Property name	Description	Without field	optional/Required	Comment
`identifier`	It is `string` of uniq content id	Unable to load the content error	Required	Its a unique content id so Its a required to log the telemetry and other data against contnet
`Name`	It is `string` to represent the name of the content or pdf	Unable to load the content error	Required	Its a required to show the name of the pdf while loading the pdf.
`streamingUrl`	It is `string` url.	Unable to load the content error	Required but optional if the artifactUrl is present	It is optional field. This is required if you want to load the streaming pdf

file from streaming url
url
artifactUrl
It is a string url
Unable to load the content error
Required but optional if streamingUrl is preset
It is required to load the pdf file.

Sample metadata object interface in offline play:

Code Block
"metadata": { "identifier": string; "name": string; "artifactUrl": string; "basePath": string; // should requird to play offline "baseDir?": string; "streamingUrl"?: string; }

Following properties are mandatory to play the content OFFLINE play.

Property name	Description	Without field	Optional/Required	Comment
`Name`	It is `string` to represent the name of the content or pdf	Unable to load the content error	Required	Its a required to show the name of the pdf while loading the pdf.
`isAvailableLocally`	It is a `boolen` value which indicate the content is locally available	Content will not load offline	Required	It is required to know - the content is downloaded and can be play offline
`artifactUrl`	It is a `string` url	Unable to load the content error	Required	It is required to load the pdf file.
`basePath`	It is `string` to represent the base path of the pdf file	Unable to load the content error	Required but optional if `baseDir` is present	It is required to load the pdf file.
`baseDir`	It is `string` to represent the base path of the pdf file	Unable to load the content error	Required but optional if `basePath` is present	It is required to load the pdf file.

Versions Compared

Old Version 1

New Version Current

Key

Introduction

Context contains the following properties:

Sample context object:

1. Context (Optional):

Sample context object interface:

2. Config (Optional)

sample config

object interface:

3. Metadata (Required)

Sample metadata object interface:

Sample metadata object interface in offline play: