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 ItemWhen a user checks the detail page of a video/audio content.
PropertiesName
Type
Required
Description
item
﻿﻿Premium Item  
Yes
The item details that the user view.
Code ExampleJS
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);
const props = {
    "item":{
        "id": "1234",
        "name": "ITEM_NAME",
        "category": {
            "id": "1234",
            "name": "CATEGORY_NAME"
        },
        "isPaid": true,
        "hasTrial": false
    }
};

cooeeSDK.sendEvent("View Item", props);
﻿
Play ItemWhen a user starts playing a video or audio.
PropertiesName
Type
Required
Description
item
﻿﻿Premium Item  
Yes
The item details that the user playing.
Code ExampleJS
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);
const props = {
    "item":{
        "id": "1234",
        "name": "ITEM_NAME",
        "category": {
            "id": "1234",
            "name": "CATEGORY_NAME"
        },
        "isPaid": true,
        "hasTrial": false
    }
};

cooeeSDK.sendEvent("Play Item", props);
﻿
Pause ItemWhen a user pauses a video/audio.
PropertiesName
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 ExampleJS
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);
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 ItemWhen the user closes or exits playing video/audio.
PropertiesName
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 ExampleJS
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);
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 ItemWhen the user closes or exits playing video/audio.
PropertiesName
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);
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 FavouriteWhen a user marks a video/audio as a favourite.
PropertiesName
Type
Required
Description
item
﻿﻿Premium Item  
Yes
The item details that the user marks it as a favourite.
Code ExampleJS
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);
const props = {
    "item":{
        "id": "1234",
        "name": "ITEM_NAME",
        "category": {
            "id": "1234",
            "name": "CATEGORY_NAME"
        },
        "isPaid": true,
        "hasTrial": false
    }
};

cooeeSDK.sendEvent("Item Favourite", props);
﻿
Item UnfavouriteWhen a user removes a video/audio from a favourite.
PropertiesName
Type
Required
Description
item
﻿﻿Premium Item  
Yes
The item details that the user removes from favourite.
Code ExampleJS
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);
const props = {
    "item":{
        "id": "1234",
        "name": "ITEM_NAME",
        "category": {
            "id": "1234",
            "name": "CATEGORY_NAME"
        },
        "isPaid": true,
        "hasTrial": false
    }
};

cooeeSDK.sendEvent("Item Unfavourite", props);
﻿
Download ItemWhen a user downloads a video/audio for offline view.
PropertiesName
Type
Required
Description
item
﻿﻿Premium Item  
Yes
The item details that is downloaded for offline view.
Code ExampleJS
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);
const props = {
    "item":{
        "id": "1234",
        "name": "ITEM_NAME",
        "category": {
            "id": "1234",
            "name": "CATEGORY_NAME"
        },
        "isPaid": true,
        "hasTrial": false
    }
};

cooeeSDK.sendEvent("Download Item", props);
﻿
Delete DownloadWhen a user downloads a video/audio for offline view.
PropertiesName
Type
Required
Description
item
﻿﻿Premium Item  
Yes
The downloaded item details which is removed from the offline view.
Code ExampleJS
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);
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
Subscription Apps
Mandatory Properties
Docs powered by archbee
Name	Type	Required	Description
item	Premium Item	Yes	The item details that the user view.