Overview

Mashup is essentially every media type supported by VIDIZMO. The list includes:


This document shall primarily help you understand Mashup object and its various properties in VIDIZMO REST API Reference.


MashupInfo Object

{
  // Primary key of mashup object in system. Used to uniquely identify mashup in system
  "id": <number>,
  // User profile of the user who created this record in system
  "addedBy": <userProfileInfo>, //Read: https://help.vidizmo.com/en/support/solutions/articles/17000110691-api-reference-guide-userinfo-object
  // Author of this mashup
  "author": <userProfileInfo>, //Read: https://help.vidizmo.com/en/support/solutions/articles/17000110691-api-reference-guide-userinfo-object
  // Tenant details to which this mashup belong
  "tenant": <tenantInfo>, // Read: https://help.vidizmo.com/en/support/solutions/articles/17000110689-api-reference-guide-tenantinfo-object
  // Category to which this mashup belong
  "category": <categoryInfo>, // Read: https://help.vidizmo.com/en/support/solutions/articles/17000110704-api-reference-guide-categoryinfo-object
  // For video and audio: Duration of media file in milliseconds
  // For playlist: Combined duration of all media files inside playlist in milliseconds
  // For document: Total number of pages
  // Does not qualify for other mashup formats like image, quiz, survey, collection and live
  "estimatedDuration": <number>,
  // HTML description of mashup
  "description": <string>,
  // Title of mashup
  "title": <string>,
  // Current version of mashup. This will be 1 at the time of creating a new mashup, and will be incremented by 1 after every update is made to the mashup
  "version": <string>,
  // Thumbnails of mashup. These thumbnails will be provided in 3 sizes. Sizes are given below
  // For playlist and collection: This object will always contain thumbnails of first mashup in collection. You cannot set thumbnails specifically for these 2 formats
  "thumbnails": [
    {
      // Full qualified CDN url of your image file
      "thumbnailURL": <string>,
      // Small = 122px height
      // Medium = 360px height
      // Large = 720px height
      "thumbnailSize": <number>
    }
  ],
  // UTC date and time on which this mashup was created. This is only set at the time of mashup creation and is set by the system. You cannot update it later on
  "createdDate": <utcDateAndTime>,
  // True, if mashup is deleted
  "isDeleted": <boolean>,
  // UTC date and time on which this mashup was updated. This property is updated on every mashup update and is set by the system
  "updatedDate": <utcDateAndTime>,
  // User profile of the user who updated this mashup
  "updatedBy": <userProfileInfo>, //Read: https://help.vidizmo.com/en/support/solutions/articles/17000110691-api-reference-guide-userinfo-object
  // For video, audio, image and document: Size of physical media file on storage in bytes
  // For playlist and collection: Combined size of all media files in bytes
  // Does not qualify for other mashup formats like Quiz, survey and live
  "size": <number>,
  // If set, this date indicates when mashup would be published in library. If set to future date, mashup won't be considered published and will not appear in library until that date is reached.
  "publishedOn": <utcDateAndTime>,
  // If set, mashup is considered expired after this date
  "expiresAfter": <utcDateAndTime>,
  // Set to true by our background service, when current date is greater then expiresAfter property
  "isExpired": <boolean>,
  // If set to true, mashup will only then appear in channel library in portal. Otherwise you can only access mashup from media manager.
  "showOnChannelLibrary": <boolean>,
  // This property indicates who can access this mashup. Below are details about its possible values
  // When set to "None": Manager can define custom rights to specific users/groups of portal to access mashup
  // When set to "Anonymous": Any user (Authenticated+Anonymous) can view the mashup
  // When set to "ChannelUsers": Only current portal users can access this mashup
  // When set to "ChannelUsersAndMainChannelUsers": Portal users and main portal users both can access mashup. This options only qualify for child portals. This is normally used when you have signed up for multiple portals and you are trying to share content of child portal with main account portal users.
  "defaultViewingAccess": <string>,
  // Current status of mashup
  // When set to "Drafted": Mashup will not appear in library, and can only be seen through draft tab of media manager
  // When set to "PendingForApproval": When mashup is awaiting moderation by the moderator
  // When set to "Published": When mashup is in published state
  // When set to "Rejected": When moderator has rejected mashup during moderation
  // When set to "Purged": When mashup is purged after deletion. If mashup status is set to "Purged", it cannot be recovered back in portal
  "status": <string>,
  // True, if mashup is marked as featured
  "isFeatured": <boolean>,
  // Weight of featured mashup. It is used to sort mashups when featured mashups are requested. Mashups with higher weights will appear on top of featured mashups list.
  "weight": <number>,
  // Format of mashup like Audio, video, image document, collection, playlist, live, survey or quiz
  "format": <string>,
  // When true, a transcription control appears on right hand side of player on VIDIZMO portal playback page
  "isTranscriptionEnabled": <boolean>,
  // When true, it indicates whether this mashup is created by clipping some other mashup in system
  "isClipping": <boolean>,
  // Contains some stats about mashup. These stats are populated from raw tracking that our player generated from our portal playback page or from other website where player is generated using iFrame or JavaScript widgets
  "mashupStats": {
    "mashupId": <number>,
    "tenantId": <number>,
    "totalComments": <number>,
    "totalFavorites": <number>,
    "totalViews": <number>,
    "totalLikes": <number>,
    "totalDislikes": <number>,
    "totalPoints": <number>,
    "totalViewers": <number>,
    "totalCompletions": <number>,
    "totalImpressions": <number>,
    "totalPlayTime": <number>,
    "totalBuffers": <number>,
    "totalErrors": <number>,
    "totalFormAttempts": <number>,
    "totalDownloads": <number>,
    "totalShares": <number>,
    "totalFeedbackImprovements": <number>,
    "totalFeedbackIssues": <number>,
    "totalFeedbackQuestions": <number>,
    "totalFeedbackAbusive": <number>,
    "totalFeedbackOthers": <number>,
    "addedDateTime": <utcDateAndTime>,
    "lastUpdatedTime": <utcDateAndTime>,
  },
  // This object is valid for authenticated users of portal and indicates what rating a user has given to this particular mashup. This object is personal for every user.
  "myRating": {
    "id": <number>,
    "value": <number>,
    // Type can be on of the following StarRating, LikeDislike
    "type": <string>,
    "subject": <string>,
    "objectId": <number>,
    "tenantId": <number>,
    "isDeleted": <boolean>,
    "userProfileId": <number>,
    "addedDateTime": <utcDateAndTime>,
    "updatedOn": <utcDateAndTime>
  },
  // This object is valid for authenticated users of portal and indicates if a user has marked it as favorite. This object is personal for every user.
  "myFavorite": {
    "id": <number>,
    "addedDateTime": <utcDateAndTime>,
    "userProfileId": <number>,
    "tenantId": <number>
  },
  // Provide list of all learning plans with which this mashup is associated
  // More about this object can be read at: https://help.vidizmo.com/en/support/solutions/articles/17000110703-api-reference-guide-learningplaninfo-object
  "learningPlans": <learningPlanInfo[]>, 
  // Provide tracking summary of this mashup. This object is personal for every authenticated user.
  "trackingSummary": [
    {
      "id": <number>,
      "mashupId": <number>,
      "userProfileId": <number>,
      "tenantId": <number>,
      "percentage": <number>,
      // True, when current user has completely watched the mashup in their last session
      "isCompleted": <boolean>,
      // Last player position of user where they left the session. This value can be used to restore state of user on player. VIDIZMO player understand this and restore user to last position.
      // Applies only to video, audio and document
      "lastPosition": <number>,
      // This property indicates that which mashup user played in their last activity for playlist or collection. This will contain mashup id of last played mashup inside a collection.
      // Applies only to playlist and collection
      "lastPlayedMashupId": <number>,
      // Last event that got tracked by the player
      "trackingEvent": "Impression"
    }
  ],
  "commentResult":{
      "comments":[
          // Include comment contract here
      ],
      "count": 922 // Total count of comments
  }
  // Indicates all mashups that exists within a collection or playlist
  // This property only qualifies for mashup formats playlist and collection
  "mashups": [
    //Read: https://help.vidizmo.com/en/support/solutions/articles/17000110563-api-reference-guide-mashupinfo-object
  ],
  // This object contains all custom attributes values against this current mashup
  "mashupCustomAttributes": [
    {
      "id": <number>,
      "customAttributeId": <number>,
      "customAttributeName": <string>,
      "customAttributeValue": <string>,
      "customAttributeFieldTypeId": <string>,
      "displayable": <boolean>,
      "searchable": <boolean>,
      "facetable": <boolean>
    }
  ],
  // Contains all tags that are attached to this mashup
  "tagsInfo": <tagInfo[]>, // Read: https://help.vidizmo.com/en/support/solutions/articles/17000110693-api-reference-guide-taginfo-object
  // Applies only to mashup format live. Indicates associated publishing point with live event.
  "publishingPointId": <number>,
  // Applies only to mashup format live. Contains start date and time of live event.
  "liveStartDateTime": <dateAndTime>,
  // Applies only to mashup format live. Contains end date and time of live event.
  "liveEndDateTime": <dateAndTime>,
  // Applies only to mashup format live. Contains offset for liveStartDateTime with regards to UTC date and time.
  "liveTimeZoneOffSet": <number>,
  // Applies only to mashup format live. Current status of live mashup. Possible values are given below
  // Running: When live session is in progress or is happening right now
  // Paused: When live session is paused
  // Canceled: When live session was cancelled after scheduling
  // Draft: When live session is in draft state
  // Upcoming: When live session is scheduled for some future date
  // Completed: When live session is completed
  // Recorded: When live session is converted into a recording after it is completed
  "liveStatus": <string>,
  // Applies only to mashup format live. Indicates whether day light factor will impact scheduled date and time
  "liveDaylightSaving": <boolean>,
  // Contains flags and some other details about live session. Qualifies only for mashup format live.
  "liveMashupDetail": {
    "remainingTimeForlive": <number>,
    "isChatEnabled": <boolean>,
    "isQAndAEnabled": <boolean>,
    "showSchedule": <boolean>,
    "schedule": <string>,
    "showTwitterFeed": <boolean>,
    "twitterWidgetId": <string>,
    "showFAQ": <boolean>,
    "faq": <string>,
    "showYammerFeed": <boolean>,
    "yammerFeedId": <string>,
    "yammerFeedType": <string>,
    "isChatArchiveEnabled": <boolean>,
    "recordings": [
      {
        "startTime": <utcDateAndTime>,
        "endTime": <utcDateAndTime>
      }
    ]
  },
  // Contains playback and download urls of media files. This object only qualifies for audio, video, image, document and live
  "content": <contentInfo[]>, // Read: https://help.vidizmo.com/en/support/solutions/articles/17000110694-api-reference-guide-contentinfo-object
  // Contains all timed data information that applies for current mashup. Timed data types can be following
  // OCR: Data captured from media file through OCR activity
  // Transcription: Transcription data of current mashup either uploaded manually by the user or generated through transcription engines.
  // Chat: Once live session is converted to on-demand mashup, all its chat is converted and is stored against this type in timed data
  // qnA: Once live session is converted to on-demand mashup, all its Q&A is converted and is stored against this type in timed data
  // face: Faces data captured through AI engines
  // brand: Brands data captured throug AI engines
  // emotion: Emotions data captured throug AI engines
  // sentiment: Sentiments data captured throug AI engines
  // label: Labels data captured throug AI engines
  // keyword: Keywords data captured throug AI engines
  // speaker: Speakers data captured throug AI engines
  // annotation: Indicates which annotation to load when a video reached a certain duration.
  // survey: Indicates which survey (mashup) to load when a video reached a certain duration.
  // quiz: Indicates which quiz (mashup) to load when a video reached a certain duration.
  // handout: Indicates which handout (small files) to load when a video reached a certain duration.
  // plugin: Indicates which custom plugin (hubspot or any other custom plugin written by the user) to load when a video reached a certain duration.
  // drone: KLV data extracted from media files generated by drones are stored against this type
  "timedData": <timedDataInfo[]>, // Read more about the object at: https://help.vidizmo.com/en/support/solutions/articles/17000110702-api-reference-guide-timeddatainfo-object
  // Different flags for player
  "player": {
    // This will contain encrypted password if mashup is password protected
    "passCode": <string>,
    // If true, a control on right hand side of player will appear which will show timed data
    "displayTimedData": <boolean>,
    // If true, player will render video in 360 mode. We do not capture 360 mode from within video so uploader will have to set it manually
    "isVideo360": <boolean>,
    // This criteria indicates at which position we should consider video as complete. Once this criteria is met in playback page, player will track complete event and video wille be considered completed
    "completionCriteria":{
      // Property to compare. Right now only "Marker" is supported.
      "property": <string>,
      // Criteria to match. Right now only "Equal To" is supported.
      "criteria": <string>,
      // Value in percentages on the scale of 1-100. If set to 89, when video reaches at 89% a complete event will be raised.
      "criteriaValue": <number>
    },
    // Template for VIDIZMO player to render itself from this template
    "playerTemplateDetail": <PlayerTemplateDetailInfo> // Read more about the object at: https://help.vidizmo.com/en/support/solutions/articles/17000110701-api-reference-guide-playertemplateinfo-object
  }
  // Contains flags for mashup player to render itself
  "participation": {
    "commentEnabled": <boolean>,
    "commentModerationRequired": <boolean>,
    "isMashupStatsEnabled": <boolean>,
    "isDownload": <boolean>,
    "isEmbed": <boolean>,
    "isSocialSharing": <boolean>
  },
  // Include live chat contract here
  "liveChat": <liveChatInfo>, // Read more about the object at: https://help.vidizmo.com/en/support/solutions/articles/17000110699-api-reference-guide-livechatinfo-object
  // Include live chat contract here
  "liveQnA": <liveQnAInfo>, // Read more about the object at: https://help.vidizmo.com/en/support/solutions/articles/17000110699-api-reference-guide-livechatinfo-object
  // If mashup is drm protected, include details about it here
  "drmInfo": {
    // DRM provider like AMS, VIDIZMO
    "drmProvider": <string>,
    "drmOptions":{
        // Below given properties are valid for DRM type
        // PlayReady, Widevine, FairPlay or Cenc
        "drmType": <string>,
        // Fully qualified HTTP url through which to obtain license
        "licenseUrl": <string>,
        // Authorization token that can be used to obtain license from license url
        "authToken": <string>
    },
    // UTC date and time of license start
    "From": <utcDateAndTime>,
    // UTC date and time of license end
    "End": <utcDateAndTime>,
    // Boolean value indicating whther license is persistence license or not
    "Persistent": <boolean>,
    "ContentKeyId": <string>,
    "AssetDeliveryPolicyId": <string>,
    "AuthorizationPolicyId": <string>
  },
  // All insights that are captured for this mashup
  "insight": <insightInfo>, // Read more about the object at: https://help.vidizmo.com/en/support/solutions/articles/17000110697-api-reference-guide-insightinfo-object
  // Status of moderation of this mashup. This object is only return when moderation policy asks users to have multiple moderators and one of those moderators moderated it.
  "mashupModerations": [
    {
      "id": <number>,
      "mashupId": <number>,
      "userProfileId": <number>,
      "moderatorName": <string>,
      "mashupStatus": <string>
    }
  ],
  // Contains checksum data for all physical files of this mashup. This object is compared with a newly generated content checksum property to indicate tamper.
  "contentsCheckSum": [
    {
      "fileName": <string>,
      "checkSum": <string>
    }
  ],
  // Tamper status of current mashup
  "tamperStatus": <string>,
  // On which particular date tamper was identified in mashup
  "verifiedTamperOn": <utcDateAndTime>
}


Read Next