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.

...

Code Block
pdfPlayerConfig = { context?: Context; config?: Config; metadata: any; // content data { _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

Optional/Required

With property

	Without

property2

authToken

Auth key to make the api call

Optional

No change in telemetry data

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

“ “

3

sid

User sessionId

Required

sid will log in telemetry

sid will not log in telemetry

field	Comment	Default	Code changes required
1

mode

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

Optional

No change in telemetry data

Can be set it as preview from the player side. There is no major impact in player preview.

"preview"

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

did5

uid

Current logged in user id

Required

uid will log in telemetry

uid will not log in telemetry

Default can be set from player side

"anoymous"

6

channel

Unique id of the channel

Required

channel id will log in telemetry

channel id will not log in telemetry

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

“ “

7

pdata

producer id

Required

{
"id": "sunbird.portal",
"ver": "3.2.12",
"pid": "sunbird-portal.contentplayer"
}

{}

Default can be set from player side

{}

8

mode

Unique id to identify the device

Required

did will log in telemetry

did will not log in telemetry

Default can be set from player side

“ “

content rollup will not log in context

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

Context rollup will log in telemetry context

{}

Its a optional field in telemetry

{}

No

9Object rollup will not log in telemetry

10

objectRollup

Defines the content object data

Optional

Object rollup will log in telemetry

{}

Its a optional field in telemetry

{}

10

No
11	`tags`

defines the tags data

Optional

Tag will log

Empty tag list will log

11

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`

Defines the correlation data12

timeDiff

It defines the time difference

Optional

No change in telemetry data

This can be a optional field

“ “

13

host

Defines the from which domain content should be loaded

Optional

No change in telemetry data

Default can be set from player side

“ “

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

Optional

Cdata will log

cdta will log in telemetry

Correlation data requires for telemetry

{}

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

No change in telemetry data

This can be a optional

	`""`	Content Player set it as “`/data/v3/telemetry`“	`/data/v3/telemetry`	No
15	`userData`	Defines the user first name and last name	Optional

End page will show the first name and last name from userData

User first and lastname will not show in endpage

Default can be set from player side

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

pdata: If we not pass the pdata the pdata will not logged in telemetry

Sample telemetry data without pdata

...

.

...

contextRollup: If we not pass the pdata the pdata will not logged in telemetry

Sample content object telemetry data without rollup

Code Block

...

firstName":

...

sid, did, uid, channel: If we not pass the pdata the pdata will not logged in telemetry

Sample telemetry data without pdata:

Code Block

{"eid":"INTERACT","ets":1662989700604,"ver":"3.0","mid":"INTERACT:df20f452603133275899885c89826a0a","actor":{"id":"ac7fa5a7da1312d0603d351c941a2813","type":"User"},"context":{"pdata":{"id":"sunbird.portal","ver":"3.2.12","pid":"sunbird-portal.contentplayer"},"env":"contentplayer","did":"ac7fa5a7da1312d0603d351c941a2813","cdata":[{"id":"QtPz7hI6rQjEqosRF3Shlwx9jhMOSzGs","type":"ContentSession"},{"id":"ikwUrq2L04DcojCek0Remi2nvmlbkJwr","type":"PlaySession"},{"id":"2.0","type":"PlayerVersion"}],"rollup":{"l1":"505c7c48ac6dc1edc9b08f21db5a571d"}},"object":{"id":"do_31291455031832576019477","ver":"undefined","type":"Content","rollup":{}},"tags":[""],"edata":{"type":"TOUCH","subtype":"","id":"next","pageid":"2"}}

tags: If we not pass the tags the empty tags will log in telemetry

Sample telemetry data without tags:

Code Block
"context": { ... "tags": [],

objectRollup: If we not pass the pdata the pdata will not logged in telemetry

Sample content object telemetry data without rollup

Code Block
"context: { }, "object": { "id": "do_31291455031832576019477", "ver": "undefined", "type": "Content", "rollup": {} },

userData: If we pass the userData, it will show in endpage.

...

If we not send - it will not show.

...

"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

{
      mode"config"?: string;{ 
     authToken"sideMenu"?: string;{ 
     sid: string;
      did: string;
      uid: string;
      channel: string; "showShare"?: boolen; // show/hide share button in side menu. default value is true
       pdata: Pdata;
      contextRollup"showDownload"?: ContextRollupboolen; // show/hide download button in side tags?: string[];
      cdata: Cdata[];menu. default value is true
        timeDiff"showReplay"?: numberboolen; // show/hide replay button in side objectRollup?: ObjectRollup;
  menu. default value is true
   host?: string;       endpoint"showExit"?: stringboolen; // show/hide exit button in side dispatcher?: object;
  menu. default value is false
   userData?: {           firstName"showPrint"?: stringboolen; // show/hide print button in side menu. default value is lastName:true
string;     }
 }; }

2. Config

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

Property name	Description	optionalOptional/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`

sideMenu: If we not pass the side menu object for pdf config - the default the following menu will show in sidemenu

Share
Download
Print

...

sample config data

...

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": { 
    "sideMenuidentifier"?: { string;
      "showSharename"?: true, // show/hide share button in side menu. default value is true: string;
        "showDownloadartifactUrl"?: true, // show/hide download button in side menu. default value is true
      "showReplay"?: true, // show/hide replay button in side menu. default value is true
      "showExit"?: false, // show/hide exit button in side menu. default value is false
      "showPrint"?: true // show/hide print button in side menu. default value is true
    }
  }

3. Metadata

...

string;
      "streamingUrl"?: string;
  }

In metadata the following properties are mandatory to play the content onlinein 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 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 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 7

New Version Current

Key

Introduction

1.

Context (Optional):

Sample context object interface:

2. Config (Optional)

sample config object interface:

2. Config

sample config data

3. Metadata (Required)

Sample metadata object interface:

3. Metadata

Sample metadata object interface in offline play: