This Web API is used by developers to play Videos in a channel for logged in users by passing the values in “get_mashup”, "email" and "mashup_id" in the “action” parameter. Additionally, the developer can pass any other optional parameter provided below to get required result set.


To set User Context and get user specific Videos back, either use VIDIZMO JS Login API before calling this method or use VIDIZMO Web Login method and additionally pass "access_token" parameter to this call API. 

If no User Context is established, videos available in anonymous mode will be played, provided the Mashup_id is of the anonymously available video.


Request



Parameters


Parameter 

Description

Email

Email address of the user who wants to play the video.

Mashup_id

The Id of the video.


Response

 

{
  "video_url": null,
  "video_id": "33633",
  "video_id_hash": "qf8OohiCWTfSkoQnKcpSNQ%3d%3d",
  "tracking_id": null,
  "tracking_id_hash": null,
  "content_id": null,
  "video_status_id": 0,
  "result": {
    "categories": null,
    "accessibility_id": 1,
    "completion_criteria": "<RuleSet><Rule Id=\"1\" Object=\"Mashup\" CriteriaType=\"2\" Property=\"Marker\" Criteria=\">=\" CriteriaValue=\"100\" /></RuleSet>",
    "timeline_duration": null,
    "data_xml": "<MashupMeta>\r\n  <MashupInfo Id=\"33633\" UserID=\"192784\" TenantID=\"33\" Title=\"Everyone Can Learn From Video\" Tags=\"\" Description=\"\" ThumbnailURL=\"https://az2310.vo.msecnd.net/ent-33/179909/Images/00000b/ImgThumbs/B8E2AF6D9207201310080416020776.jpg\" Version=\"5\" Copyrights=\"\" IsFeatured=\"True\" LicenceInformation=\"\" TargetAudience=\"\" TargetIndustry=\"\" IsPreview=\"\" IsSellable=\"\" MashupSize=\"40036733\" IsLiveMashup=\"False\" MashupDuration=\"215\" AccessibilityId=\"1\" IsPublicInternally=\"\" IsFree=\"\" LiveSessionProfileId=\"\" LiveSessionProfileName=\"\" ClientTimeZoneOffSet=\"0\" IsDaylightSaving=\"False\" LiveMashupId=\"\" IsDisabled=\"False\" IsSwfEnable=\"False\" IsFixedPlayer=\"False\" PlayerAspectRatioMode=\"1\" StudioPlayerSize=\"520x293\" CommentEnabled=\"True\" CommentModerationRequired=\"True\" ThemeId=\"398\" ShowOnChannelLibrary=\"True\" ExtendedProperties=\"PlayerMode=2,Languages=,PlayerLayout=4,IsShowInstantReport=False,StreamingMode=2,IsOfflineIconShow= True,PlayerRatioDivisible=1.78082191780822,IsEmbed=True,IsSocialSharing=False,IsScormIconShow=False,EncodedMashup=True\" PublishedOn=\"10/8/2013 4:14:35 PM\" ExpiresAfter=\"\" IsUserGeneratedThumbnail=\"False\" ThumbImageURLMedium=\"https://az2310.vo.msecnd.net/ent-33/179909/Images/000009/ImgThumbs/9A9FF64B978B201310080416012585.jpg\" ThumbImageURLLarge=\"https://az2310.vo.msecnd.net/ent-33/179909/Images/00000f/ImgThumbs/F422129DE54F201310080415588562.jpg\">\r\n    <ProviderInfo>\r\n      <ProviderBase URL=\"az2310.vo.msecnd.net\" Key=\"\" ProviderTypeId=\"4\" />\r\n      <ProviderBase URL=\"az2310.vo.msecnd.net\" Key=\"\" ProviderTypeId=\"4\" />\r\n    </ProviderInfo>\r\n    <Categories>\r\n      <Category Id=\"94072\" CategoryId=\"596\" CategoryName=\"Business Development\" IsPreview=\"False\" />\r\n    </Categories>\r\n    <Marker NavigateDurationInMilliSeconds=\"-1\" IsHandout=\"False\" Id=\"739777\" IsDelete=\"False\" IsDisable=\"False\" ContentId=\"0\" Title=\"Completion at 100%\" Summary=\"\" Description=\"\" Tags=\"\" Guid=\"70a3fb55-e81e-460c-b38a-d4edc1bfbdc7\" Name=\"Completion at 100%\" RunTimeBehaviour=\"0\" StartTime=\"00:03:34.9800000\" EndTime=\"00:03:35.0800000\" ActualStartTime=\"00:03:34.9800000\" ActualEndTime=\"00:03:35.0800000\" MarkerType=\"3\" Type=\"Marker\" isReadonly=\"True\" />\r\n    <Marker NavigateDurationInMilliSeconds=\"-1\" IsHandout=\"False\" Id=\"739778\" IsDelete=\"False\" IsDisable=\"False\" ContentId=\"0\" Title=\"Completion at 25%\" Summary=\"\" Description=\"\" Tags=\"\" Guid=\"a6d11b23-d80d-4a9a-9abd-14e4d33ae346\" Name=\"Completion at 25%\" RunTimeBehaviour=\"0\" StartTime=\"00:00:53.7450000\" EndTime=\"00:00:53.8450000\" ActualStartTime=\"00:00:53.7450000\" ActualEndTime=\"00:00:53.8450000\" MarkerType=\"2\" Type=\"Marker\" isReadonly=\"True\" />\r\n    <Marker NavigateDurationInMilliSeconds=\"-1\" IsHandout=\"False\" Id=\"739779\" IsDelete=\"False\" IsDisable=\"False\" ContentId=\"0\" Title=\"Completion at 50%\" Summary=\"\" Description=\"\" Tags=\"\" Guid=\"18e6a804-0670-4081-8f50-2204ce996167\" Name=\"Completion at 50%\" RunTimeBehaviour=\"0\" StartTime=\"00:01:47.4900000\" EndTime=\"00:01:47.5900000\" ActualStartTime=\"00:01:47.4900000\" ActualEndTime=\"00:01:47.5900000\" MarkerType=\"2\" Type=\"Marker\" isReadonly=\"True\" />\r\n    <Marker NavigateDurationInMilliSeconds=\"-1\" IsHandout=\"False\" Id=\"739780\" IsDelete=\"False\" IsDisable=\"False\" ContentId=\"0\" Title=\"Completion at 75%\" Summary=\"\" Description=\"\" Tags=\"\" Guid=\"ee8d1af7-86ac-4c6b-be8c-d9e4cf259238\" Name=\"Completion at 75%\" RunTimeBehaviour=\"0\" StartTime=\"00:02:41.2350000\" EndTime=\"00:02:41.3350000\" ActualStartTime=\"00:02:41.2350000\" ActualEndTime=\"00:02:41.3350000\" MarkerType=\"2\" Type=\"Marker\" isReadonly=\"True\" />\r\n    <Video Id=\"670550\" ContentId=\"518337\" IsHandout=\"False\" NavigateDurationInMilliSeconds=\"-1\" Title=\"Everyone Can Learn From Video\" IsDisable=\"False\" IsDelete=\"False\" Tags=\"\" Description=\"\" Duration=\"00:03:34.9800000\" Summary=\"\" Name=\"Everyone Can Learn From Video\" Width=\"520\" Height=\"292\" Opacity=\"1\" ZIndex=\"\" URL=\"http://az2310.vo.msecnd.net/ent-33/179909/Videos/00000d/D866BA67534D201310080414314023.mp4\" ActualHeight=\"720\" ActualWidth=\"1280\" BitRate=\"0\" Infinite=\"\" IsLiveStream=\"\" CursorStyle=\"\" DisplaySize=\"Uniform\" FrameRatePerSecond=\"0\" Mute=\"False\" PointOfOrigin=\"0,0\" Position=\"00:00:00\" Resolution=\"\" RunTimeBehaviour=\"0\" SpeakerBalance=\"0\" SpeedRatio=\"0\" StartFromPosition=\"00:00:00\" StartTime=\"00:00:00\" EndTime=\"00:03:34.9800000\" ActualStartTime=\"00:00:00\" ActualEndTime=\"00:03:34.9800000\" Status=\"\" Type=\"Video\" Volume=\"1\" ContentSize=\"40036733\" ThumbnailUrl=\"https://az2310.vo.msecnd.net/ent-33/179909/Images/00000b/ImgThumbs/B8E2AF6D9207201310080416020776.jpg\" SequenceNumber=\"0\" ViewingPane=\"1\" IsPrimaryStream=\"False\" BufferTime=\"5\" ClosedCaptionUrl=\"\" ThumbImageURLMedium=\"https://az2310.vo.msecnd.net/ent-33/179909/Images/000009/ImgThumbs/9A9FF64B978B201310080416012585.jpg\" ThumbImageURLLarge=\"https://az2310.vo.msecnd.net/ent-33/179909/Images/00000f/ImgThumbs/F422129DE54F201310080415588562.jpg\" IsSubscribedStream=\"False\">\r\n      <MashupContentFiles>\r\n        <MashupContentFile URL=\"http://az2310.vo.msecnd.net/ent-33/179909/Videos/00000d/D866BA67534D201310080414314023_0X480_480p.webm\" MediaInformation=\"\" Width=\"0\" Height=\"480\" FrameRatePerSec=\"30\" BitRateKbs=\"1486\" IsEnable=\"True\" ContentFileId=\"20208\" DeviceClass=\"\" IsSubscribedStream=\"False\" LiveSessionConfigProfileId=\"0\" StreamingServerConfigurationId=\"0\" StreamTypeId=\"0\" />\r\n        <MashupContentFile URL=\"http://az2310.vo.msecnd.net/ent-33/179909/Videos/00000d/D866BA67534D201310080414314023_0X480_480p.mp4\" MediaInformation=\"silverlight\" Width=\"0\" Height=\"480\" FrameRatePerSec=\"30\" BitRateKbs=\"1486\" IsEnable=\"True\" ContentFileId=\"20209\" DeviceClass=\"\" IsSubscribedStream=\"False\" LiveSessionConfigProfileId=\"0\" StreamingServerConfigurationId=\"0\" StreamTypeId=\"0\" />\r\n        <MashupContentFile URL=\"http://az2310.vo.msecnd.net/ent-33/179909/Videos/00000d/D866BA67534D201310080414314023_1280X720_720p.mp4\" MediaInformation=\"silverlight\" Width=\"1280\" Height=\"720\" FrameRatePerSec=\"30\" BitRateKbs=\"1486\" IsEnable=\"True\" ContentFileId=\"20210\" DeviceClass=\"\" IsSubscribedStream=\"False\" LiveSessionConfigProfileId=\"0\" StreamingServerConfigurationId=\"0\" StreamTypeId=\"0\" />\r\n        <MashupContentFile URL=\"http://az2310.vo.msecnd.net/ent-33/179909/Videos/00000d/D866BA67534D201310080414314023_1280X720_720p.webm\" MediaInformation=\"\" Width=\"1280\" Height=\"720\" FrameRatePerSec=\"30\" BitRateKbs=\"1486\" IsEnable=\"True\" ContentFileId=\"20211\" DeviceClass=\"\" IsSubscribedStream=\"False\" LiveSessionConfigProfileId=\"0\" StreamingServerConfigurationId=\"0\" StreamTypeId=\"0\" />\r\n        <MashupContentFile URL=\"http://az2310.vo.msecnd.net/ent-33/179909/Videos/00000d/D866BA67534D201310080414314023_0X360_360p.webm\" MediaInformation=\"\" Width=\"0\" Height=\"360\" FrameRatePerSec=\"30\" BitRateKbs=\"1486\" IsEnable=\"True\" ContentFileId=\"20212\" DeviceClass=\"\" IsSubscribedStream=\"False\" LiveSessionConfigProfileId=\"0\" StreamingServerConfigurationId=\"0\" StreamTypeId=\"0\" />\r\n        <MashupContentFile URL=\"http://az2310.vo.msecnd.net/ent-33/179909/Videos/00000d/D866BA67534D201310080414314023_0X360_360p.mp4\" MediaInformation=\"silverlight\" Width=\"0\" Height=\"360\" FrameRatePerSec=\"30\" BitRateKbs=\"1486\" IsEnable=\"True\" ContentFileId=\"20213\" DeviceClass=\"\" IsSubscribedStream=\"False\" LiveSessionConfigProfileId=\"0\" StreamingServerConfigurationId=\"0\" StreamTypeId=\"0\" />\r\n        <MashupContentFile URL=\"http://az2310.vo.msecnd.net/ent-33/179909/Videos/00000d/D866BA67534D201310080414314023_426X0_240p.mp4\" MediaInformation=\"silverlight\" Width=\"426\" Height=\"0\" FrameRatePerSec=\"30\" BitRateKbs=\"1486\" IsEnable=\"True\" ContentFileId=\"20214\" DeviceClass=\"\" IsSubscribedStream=\"False\" LiveSessionConfigProfileId=\"0\" StreamingServerConfigurationId=\"0\" StreamTypeId=\"0\" />\r\n        <MashupContentFile URL=\"http://az31096.vo.msecnd.net/ent-33/179909/Videos/00000d/D866BA67534D201310080414314023_ss.ism\" MediaInformation=\"silverlight\" Width=\"0\" Height=\"0\" FrameRatePerSec=\"30\" BitRateKbs=\"1486\" IsEnable=\"True\" ContentFileId=\"20215\" DeviceClass=\"\" IsSubscribedStream=\"False\" LiveSessionConfigProfileId=\"0\" StreamingServerConfigurationId=\"0\" StreamTypeId=\"0\" />\r\n        <MashupContentFile URL=\"http://az2310.vo.msecnd.net/ent-33/179909/Videos/00000d/D866BA67534D201310080414314023_426X0_240p.webm\" MediaInformation=\"\" Width=\"426\" Height=\"0\" FrameRatePerSec=\"30\" BitRateKbs=\"1486\" IsEnable=\"True\" ContentFileId=\"20216\" DeviceClass=\"\" IsSubscribedStream=\"False\" LiveSessionConfigProfileId=\"0\" StreamingServerConfigurationId=\"0\" StreamTypeId=\"0\" />\r\n        <MashupContentFile URL=\"http://az2310.vo.msecnd.net/ent-33/179909/Videos/00000d/D866BA67534D201310080414314023_iphonestream.m3u8\" MediaInformation=\"\" Width=\"0\" Height=\"0\" FrameRatePerSec=\"30\" BitRateKbs=\"1486\" IsEnable=\"True\" ContentFileId=\"20217\" DeviceClass=\"\" IsSubscribedStream=\"False\" LiveSessionConfigProfileId=\"0\" StreamingServerConfigurationId=\"0\" StreamTypeId=\"0\" />\r\n      </MashupContentFiles>\r\n    </Video>\r\n    <MashupObjectAssociations />\r\n  </MashupInfo>\r\n</MashupMeta>",
    "version": 5,
    "copyrights": null,
    "license_information": null,
    "is_user_generated_thumbnail": false,
    "target_audience": null,
    "target_industry": null,
    "is_deleted": false,
    "is_preview": null,
    "updated_by_user": {
      "is_active": false,
      "is_deleted": false,
      "registration_status": 0,
      "IsSubscribedUser": null,
      "roles": null,
      "user_profile": {
        "id": 0,
        "first_name": "malik.raza",
        "last_name": "",
        "email_address": null
      },
      "tenant": null,
      "tenant_id": 33,
      "user_id": 0
    },
    "mashup_contents_info": null,
    "mashup_session_info": null,
    "mashup_user_license_ranges_info": null,
    "mashup_user_access_right": null,
    "total_comments": 2,
    "owned_date": null,
    "mashup_preview": null,
    "attributes_xaml": null,
    "phone_no": null,
    "live_mashup_id": null,
    "live_session_profile_id": null,
    "live_session_profile_name": null,
    "live_session_profile": null,
    "license_info_detail_data": null,
    "license_id": 1,
    "session_id": null,
    "recorded_mashup_session_id": null,
    "is_acquired": null,
    "client_time_zone_offset": 0,
    "is_daylight_saving": false,
    "is_disabled": null,
    "is_fixed_player": false,
    "player_aspect_ratio_mode": 0,
    "studio_player_size": null,
    "player": {
      "background_image_url": null,
      "color_xml": "<Themes>\r\n  <TopbarColor Color=\"#FFE10030\" />\r\n  <SwapPanelColor Color=\"#FFA4314A\" IsWhiteControlBar=\"False\" />\r\n  <BalloonColor Color=\"#FFFE0000\" />\r\n  <BackgroundColor Color=\"#FFFFFFFF\" />\r\n</Themes>",
      "create_date_time": "2013-05-13T02:31:44.133",
      "created_by": 7407,
      "id": 398,
      "is_default": true,
      "is_deleted": false,
      "tenant_id": 33,
      "title": "Theme1",
      "updated_by": 7407,
      "updated_date_time": "2013-05-13T02:33:40.74"
    },
    "cdn_tlu_collection": null,
    "licensed_user_id": 1,
    "available_from": "2013-10-08T16:14:35.247",
    "expires_after": null,
    "auto_play": false,
    "auto_advance": false,
    "loop": false,
    "enforce_order": false,
    "enforce_completion": false,
    "comments_enabled": true,
    "playlist_mashups": null,
    "error": null,
    "default_viewing_access": 1,
    "comment_moderation_required": true,
    "client_offset": 0,
    "preview_timeline_duration": null,
    "total_sessions": 0,
    "subscribtion_transaction_id": "0",
    "custom_mashup_attributes": null,
    "id": 33633,
    "id_hash": "qf8OohiCWTfSkoQnKcpSNQ%3d%3d",
    "weight": 14,
    "title": "Everyone Can Learn From Video",
    "duration": 215,
    "thumbnail_url": "https://az2310.vo.msecnd.net/ent-33/179909/Images/00000b/ImgThumbs/B8E2AF6D9207201310080416020776.jpg",
    "content_count": 0,
    "thumbnail_large_url": "https://az2310.vo.msecnd.net/ent-33/179909/Images/00000f/ImgThumbs/F422129DE54F201310080415588562.jpg",
    "thumbnail_medium_url": "https://az2310.vo.msecnd.net/ent-33/179909/Images/000009/ImgThumbs/9A9FF64B978B201310080416012585.jpg",
    "long_description": "",
    "description": "",
    "size": 40036733,
    "tenant": {
      "id": 33,
      "name": null,
      "domain": "acme.enterprisetube.com",
      "logo_url": null,
      "parent_tenant_id": 0,
      "weight": 0,
      "is_featured": null,
      "welcome_message": null,
      "welcome_title": null,
      "parent_tenant_logo_url": null
    },
    "owner": {
      "user_profile": {
        "id": 0,
        "first_name": "malik.raza",
        "last_name": "",
        "email_address": null
      },
      "tenant": null,
      "tenant_id": 0,
      "user_id": 179909
    },
    "tags": [],
    "created_date": "2013-10-08T16:13:57.097Z",
    "published_date": "2015-01-27T06:55:58.453Z",
    "is_live": false,
    "is_sellable": false,
    "price": null,
    "total_likes": 0,
    "total_dislikes": 0,
    "total_rating": 0,
    "total_favorites": 0,
    "total_bans": 0,
    "total_views": 30,
    "is_featured": true,
    "channel_name": null,
    "mashup_status": 3,
    "updated_date": "2015-02-27T10:46:07.183",
    "mashup_format": 8,
    "number_of_users": 0,
    "is_enforce_quiz_completion": false,
    "is_expired": false,
    "show_on_channel_library": true,
    "total_no_of_sessions": 0,
    "mashup_status_value": "Published",
    "mashup_meta_info_tag": null,
    "mashup_meta_info_category_name": null,
    "mashup_format_value": "Video",
    "published_on": "2013-10-08T16:14:35.247"
  },
  "status": 1,
  "status_code": 200,
  "message": null
}

 


To learn more how these Widgets work, click here on VIDIZMO Web API Library.

For a complete list of VIDIZMO APIs, click here on VIDIZMO Developer APIs.