trackMedia

trackMedia

Contains constants and functions for a Track Media Event.

The structure for a Track Media Event is as follows:

{
  payload: {
    ACPExtensionEventData: {
      trackerid: <string>,
      sessionid: <string>,
      event.name: <string>,
      event.param: <object>,
      event.metadata: <object>,
      event.timestamp: <number>,
      event.internal: <boolean>,
    },
    ACPExtensionEventSource: 'com.adobe.eventsource.media.trackmedia'
    ACPExtensionEventType: 'com.adobe.eventtype.media'
    ACPExtensionEventName: <string>,
    ACPExtensionEventNumber: <integer>,
    ACPExtensionEventUniqueIdentifier: <string>,
  },
  type: 'generic'
  vendor: <string>,
  annotations: <array>,
  clientId: <string>,
  timestamp: <number>,
  uuid: <string>,
}
Source:

Members

(static, constant) EVENT_SOURCE

The value for eventSource for a Track Media Event.

Path is payload,ACPExtensionEventSource.

Source:

(static, constant) EVENT_TYPE

The value for eventType for a Track Media Event.

Path is payload,ACPExtensionEventType.

Source:

(static, constant) group

A grouping for this object

Source:

(static, constant) label

A label that can be used when describing this object

Source:

(static, constant) matcher

Matcher can be used to find matching Track Media Event objects.

Source:
See:
  • kit.match

(static, constant) parentDepth

Describes the number of parents this object has based off schema references. When checking for matches for example, we want to use a schema that is more specific over a more generic schema

Source:

(static, constant) path :string

Paths for the keys on a Track Media Event

Properties:
Name Type Description
payload string

An object with custom data describing the event.
Path is payload.
eventData string

An object with the custom data describing the event.
Path is payload.ACPExtensionEventData.
trackerid string

The unique tracker ID.
Path is payload.ACPExtensionEventData.trackerid.
sessionid string

The unique session ID.
Path is payload.ACPExtensionEventData.sessionid.
mediaEventName string

The event name.
Path is payload.ACPExtensionEventData."event.name".
eventParams string

Information about the event based on the event type.
Path is payload.ACPExtensionEventData."event.param".
eventMetadata string

An object with the standard and custom data describing the event.
Path is payload.ACPExtensionEventData."event.metadata".
eventTimestamp string

The event timestamp.
Path is payload.ACPExtensionEventData."event.timestamp".
eventInternal string

Display the event in griffon if set to false.
Path is payload.ACPExtensionEventData."event.internal".
eventSource string

The event source.
Path is payload.ACPExtensionEventSource.
eventType string

The event type.
Path is payload.ACPExtensionEventType.
eventName string

The name of the event.
Path is payload.ACPExtensionEventName.
sdkEventNumber string

The event number generated by the SDK.
Path is payload.ACPExtensionEventNumber.
eventId string

The unique event id.
Path is payload.ACPExtensionEventUniqueIdentifier.
rootType string

The type of event.
Path is type.
vendor string

The vendor of the plugin that sent the event.
Path is vendor.
annotations string

Array of Annotation objects.
Path is annotations.
clientId string

A unique id that differentiates clients from one another.
Path is clientId.
timestamp string

When the event occurred.
Path is timestamp.
rootId string

Uniquely identifies each event.
Path is uuid.
Source:

(static, constant) ROOT_TYPE

The value for rootType for a Track Media Event.

Path is type.

Source:

Methods

(static) get(alias, data) → {*}

Retrieves a value from the object. You can provide either a path or an alias.

Parameters:
Name Type Description
alias string

Path or alias
data *

Data to search
Source:

(static) getEventInternal(source) → {boolean}

Returns the eventInternal from the Track Media Event. This is the display the event in griffon if set to false.

Path is payload,ACPExtensionEventData,event.internal.

Parameters:
Name Type Description
source object

The Track Media Event instance
Source:

(static) getEventMetadata(source) → {object}

Returns the eventMetadata from the Track Media Event. This is the an object with the standard and custom data describing the event.

Path is payload,ACPExtensionEventData,event.metadata.

Parameters:
Name Type Description
source object

The Track Media Event instance
Source:

(static) getEventMetadataKey(…path, source) → {*}

Returns the data using the specified path from the eventMetadata of the Track Media Event.

Parameters:
Name Type Attributes Description
path string <repeatable>

key in object
source object

The Track Media Event instance
Source:

(static) getEventParams(source) → {object}

Returns the eventParams from the Track Media Event. This is the information about the event based on the event type.

Path is payload,ACPExtensionEventData,event.param.

Parameters:
Name Type Description
source object

The Track Media Event instance
Source:

(static) getEventParamsKey(…path, source) → {*}

Returns the data using the specified path from the eventParams of the Track Media Event.

Parameters:
Name Type Attributes Description
path string <repeatable>

key in object
source object

The Track Media Event instance
Source:

(static) getEventTimestamp(source) → {number}

Returns the eventTimestamp from the Track Media Event. This is the the event timestamp.

Path is payload,ACPExtensionEventData,event.timestamp.

Parameters:
Name Type Description
source object

The Track Media Event instance
Source:

(static) getMediaEventName(source) → {string}

Returns the mediaEventName from the Track Media Event. This is the the event name.

Path is payload,ACPExtensionEventData,event.name.

Parameters:
Name Type Description
source object

The Track Media Event instance
Source:

(static) getSessionid(source) → {string}

Returns the sessionid from the Track Media Event. This is the the unique session ID.

Path is payload,ACPExtensionEventData,sessionid.

Parameters:
Name Type Description
source object

The Track Media Event instance
Source:

(static) getTrackerid(source) → {string}

Returns the trackerid from the Track Media Event. This is the the unique tracker ID.

Path is payload,ACPExtensionEventData,trackerid.

Parameters:
Name Type Description
source object

The Track Media Event instance
Source:

(static) isMatch(source) → {boolean}

Tests the provided source against the matcher to see if it's Track Media Event event.

Parameters:
Name Type Description
source object

The Track Media Event instance
Source:
See:
  • kit.isMatch

(static) make(…input) → {object}

Generates a Track Media Event with the const values set. Can be useful in testing. Can provide additional data by providing a flat object of paths and values.

Parameters:
Name Type Attributes Description
input function <repeatable>

Overrides
Source:

(static) mock(…input) → {object}

Generates a Track Media Event with some default values set. Can be useful in testing. Can override defaults and provide additional data by providing a flat object of paths and values.

Parameters:
Name Type Attributes Description
input function <repeatable>

Overrides
Source: