website logo
HomeGo to Dashboard
User Guide
How-To Videos
Developers
Navigate through spaces
⌘K
Getting Started
Introduction
Compatibility
Terminology
SDK Installation
Shopify
Any Website
Dukaan
Angular 2+
WooCommerce
WordPress
Android Native
iOS Native
Flutter
Cordova
Ionic
React Native
Data Integration
Data Models
Mandatory Events
Mandatory Properties
Call to Action
System Events
Device Properties
Docs powered by archbee 

Video/Audio Apps

32min

The following events are needed for those business domains which are primarily video/audio based apps and monetize using videos/audios.

As our terminology says, for a video-based app, the Item is your Video/Audio content.

View Item

When a user checks the detail page of a video/audio content.

Properties

Name

Type

Required

Description

item

Premium Item

Yes

The item details that the user view.

Code Example

JS
TypeScript
Java
Kotlin
ObjectiveC
Swift
Dart
|
const props = {
    "item":{
        "id": "1234",
        "name": "ITEM_NAME",
        "category": {
            "id": "1234",
            "name": "CATEGORY_NAME"
        },
        "isPaid": true,
        "hasTrial": false
    }
};

cooeeSDK.sendEvent("View Item", props);


Play Item

When a user starts playing a video or audio.

Properties

Name

Type

Required

Description

item

Premium Item

Yes

The item details that the user playing.

Code Example

JS
TypeScript
Java
Kotlin
ObjectiveC
Swift
Dart
|
const props = {
    "item":{
        "id": "1234",
        "name": "ITEM_NAME",
        "category": {
            "id": "1234",
            "name": "CATEGORY_NAME"
        },
        "isPaid": true,
        "hasTrial": false
    }
};

cooeeSDK.sendEvent("Play Item", props);


Pause Item

When a user pauses a video/audio.

Properties

Name

Type

Required

Description

item

Premium Item

Yes

The item details that the user paused.

durationWatched

Number (Seconds)

Yes

How much time the user was watching/listening to the specific item.

watchedTill

Number (Seconds)

Yes

Video/Audio time on which user paused it. Time in seconds

Code Example

JS
TypeScript
Java
Kotlin
ObjectiveC
Swift
Dart
|
const props = {
    "item":{
        "id": "1234",
        "name": "ITEM_NAME",
        "category": {
            "id": "1234",
            "name": "CATEGORY_NAME"
        },
        "isPaid": true,
        "hasTrial": false
    },
    "durationWatched": 120,
    "watchedTill": 190
};

cooeeSDK.sendEvent("Pause Item", props);


Exit Item

When the user closes or exits playing video/audio.

Properties

Name

Type

Required

Description

item

Premium Item

Yes

The item details that the user exit playing.

durationWatched

Number (Seconds)

Yes

How much time the user was watching/listening to the specific item. Time in seconds

watchedTill

Number (Seconds)

Yes

Video/Audio time on which user exit it.

Time in seconds

Code Example

JS
TypeScript
Java
Kotlin
ObjectiveC
Swift
Dart
|
const props = {
    "item":{
        "id": "1234",
        "name": "ITEM_NAME",
        "category": {
            "id": "1234",
            "name": "CATEGORY_NAME"
        },
        "isPaid": true,
        "hasTrial": false
    },
    "durationWatched": 120,
    "watchedTill": 190
};

cooeeSDK.sendEvent("Exit Item", props);


Seek Item

When the user closes or exits playing video/audio.

Properties

Name

Type

Required

Description

item

Premium Item

Yes

The item details that the user seek.

gesture

String

Yes

Video/Audio is seek to FORWARD/REVERSE.

seekDuration

Number (Seconds)

No

How much video/audio seek in seconds.

Code Example

The following example includes optional properties too.

JS
TypeScript
Java
Kotlin
ObjectiveC
Swift
Dart
|
const props = {
    "item":{
        "id": "1234",
        "name": "ITEM_NAME",
        "category": {
            "id": "1234",
            "name": "CATEGORY_NAME"
        },
        "isPaid": true,
        "hasTrial": false
    },
    "gesture": "REVERSE",
    "seekDuration": 190
};

cooeeSDK.sendEvent("Seek Item", props);


Item Favourite

When a user marks a video/audio as a favourite.

Properties

Name

Type

Required

Description

item

Premium Item

Yes

The item details that the user marks it as a favourite.

Code Example

JS
TypeScript
Java
Kotlin
ObjectiveC
Swift
Dart
|
const props = {
    "item":{
        "id": "1234",
        "name": "ITEM_NAME",
        "category": {
            "id": "1234",
            "name": "CATEGORY_NAME"
        },
        "isPaid": true,
        "hasTrial": false
    }
};

cooeeSDK.sendEvent("Item Favourite", props);


Item Unfavourite

When a user removes a video/audio from a favourite.

Properties

Name

Type

Required

Description

item

Premium Item

Yes

The item details that the user removes from favourite.

Code Example

JS
TypeScript
Java
Kotlin
ObjectiveC
Swift
Dart
|
const props = {
    "item":{
        "id": "1234",
        "name": "ITEM_NAME",
        "category": {
            "id": "1234",
            "name": "CATEGORY_NAME"
        },
        "isPaid": true,
        "hasTrial": false
    }
};

cooeeSDK.sendEvent("Item Unfavourite", props);


Download Item

When a user downloads a video/audio for offline view.

Properties

Name

Type

Required

Description

item

Premium Item

Yes

The item details that is downloaded for offline view.

Code Example

JS
TypeScript
Java
Kotlin
ObjectiveC
Swift
Dart
|
const props = {
    "item":{
        "id": "1234",
        "name": "ITEM_NAME",
        "category": {
            "id": "1234",
            "name": "CATEGORY_NAME"
        },
        "isPaid": true,
        "hasTrial": false
    }
};

cooeeSDK.sendEvent("Download Item", props);


Delete Download

When a user downloads a video/audio for offline view.

Properties

Name

Type

Required

Description

item

Premium Item

Yes

The downloaded item details which is removed from the offline view.

Code Example

JS
TypeScript
Java
Kotlin
ObjectiveC
Swift
Dart
|
const props = {
    "item":{
        "id": "1234",
        "name": "ITEM_NAME",
        "category": {
            "id": "1234",
            "name": "CATEGORY_NAME"
        },
        "isPaid": true,
        "hasTrial": false
    }
};

cooeeSDK.sendEvent("Delete Download", props);




Updated 03 Mar 2023
Did this page help you?
Yes
No
PREVIOUS
Subscription Apps
NEXT
Mandatory Properties
Docs powered by archbee 
TABLE OF CONTENTS
View Item
Properties
Code Example
Play Item
Properties
Code Example
Pause Item
Properties
Code Example
Exit Item
Properties
Code Example
Seek Item
Properties
Code Example
Item Favourite
Properties
Code Example
Item Unfavourite
Properties
Code Example
Download Item
Properties
Code Example
Delete Download
Properties
Code Example