1. Ensemble Video Support
  2. User Guides
  3. Integrations

Plugin Documentation for v3.0

Follow
Avatar
Roman Markowski

Contents

General Plugin Parameters

Parameters are applied to the plugin by specifying them in the plugin URL as in "http://ensemble.myinstitution.edu/ensemble/plugin/plugin.aspx?displayCategoryList=true&displayContainerID=videoList" and can be chained together as the examples show.

  • displayCategoryList = true/false (defaults to "false")
Enables or disables the display of the category list in showcase mode or in the category list.
Examples:
Enable simple category list
/ensemble/plugin/plugin.aspx?displayCategoryList=true
Enable category list in showcase mode
/ensemble/plugin/plugin.aspx?displayCategoryList=true&displayShowcase=true
Enable category list with vertical orientation
/ensemble/plugin/plugin.aspx?displayCategoryList=true&categoryOrientation=vertical
  • categoryOrientation = vertical/horizontal (defaults to "horizontal")
Specifies the orientation of the category list when displaying the category list by itself or when in showcase mode.
Example:
Enable category list with vertical orientation
/ensemble/plugin/plugin.aspx?displayCategoryList=true&categoryOrientation=vertical
  • displayShowcase = true/false (defaults to "false")
Enables or disables the showcase mode which creates a simple video showcase page.
Examples:
Enable showcase mode with category list
/ensemble/plugin/plugin.js?displayCategoryList=true&displayShowcase=true
Enable showcase mode without category list
/ensemble/plugin/plugin.aspx?displayCategoryList=false&displayShowcase=true
  • newVideoOrientation = vertical/horizontal (defaults to "vertical")
Specifies the orientation of the new video list when displaying the new videos in showcase mode.
Example:
Enable a horizontal listing of new videos
/ensemble/plugin/plugin.aspx?displayShowcase=true&newVideoOrientation=horizontal
  • enablePeriodicalUpdate = true/false (defaults to "false")
Enables the periodical update of the content. Once enabled the content will refresh every 20 seconds (by default). This parameter is used in conjunction with the periodicalUpdateInterval parameter.
Please Note: If the content is using the flash player and the user is playing the video, the page update is disabled until the video is either stopped or paused.
Example:
Enable the periodical update with the default 20 second interval
/ensemble/plugin/plugin.aspx?enablePeriodicalUpdate=true
  • periodicalUpdateInterval = Any integer value in seconds >= 20 (defaults to "20")
Sets the interval at which the page content will be updated. This parameter is used in conjunction with the enablePeriodicalUpdate parameter.
Please Note: If this value is set to lower than the default 20 seconds, the periodical update will be disabled.
Example:
Enable the periodical update at 30 second intervals
/ensemble/plugin/plugin.aspx?enablePeriodicalUpdate=true&periodicalUpdateInterval=30
  • displayContainerID = any existing HTML element ID (defaults to "videoList")
Specifies the ID of the HTML container where the plugin will insert the data. Can be used in every plugin instance to override the default plugin results container.
Example:
Enable simple category list and show the results inside the HTML element with ID "videoList"
/ensemble/plugin/plugin.aspx?displayCategoryList=true&displayContainerID=videoList

 

Browse Mode Parameters

These parameters apply to the display of multiple videos in "browse" mode.

  • displayFullDescription = true/false (defaults to "false")
Enables or disables the display of the full video description.
Example:
Enable the display of the full video description
/ensemble/plugin/plugin.aspx?displayFullDescription=true
  • displayVideoDuration = true/false (defaults to "false")
Enables or disables the display of the video duration under the description.
Example:
Enable the display of the full video duration
/ensemble/plugin/plugin.aspx?displayVideoDuration=true

Individual Video Parameters

These parameters apply to the detailed content page.

  • displayCredits = true/false (defaults to "true")
Enables or disables the display of the video credits in the individual video page.
Example:
Disable the display of the video credits
/ensemble/plugin/plugin.aspx?displayCredits=false
  • displayLinks = true/false (defaults to "true")
Enables or disables the display of the links in the individual video page.
Example:
Disable the display of the links
/ensemble/plugin/plugin.aspx?displayLinks=false
  • displayAttachments = true/false (defaults to "true")
Enables or disables the display of the video attachments in the individual video page.
Example:
Disable the display of the video attachments
/ensemble/plugin/plugin.aspx?displayAttachments=false
  • displayStatistics = true/false (defaults to "true")
Enables or disables the display of the video statistics in the individual video page.
Example:
Disable the display of the video statistics
/ensemble/plugin/plugin.aspx?displayStatistics=false
  • displayEmbedCode = true/false (defaults to "true")
Enables or disables the display of the embed code in the individual video page.
Example:
Disable the display of the video link and embedding code
/ensemble/plugin/plugin.aspx?displayInformation=false
  • displaySharing = true/false (defaults to "false")
Enables or disables the display of social networking icons/links in the individual video page.
Example:
Enable the display of social networking icons/links
/ensemble/plugin/plugin.aspx?displaySharing=true
  • maxContentWidth = Any whole integer (defaults to 640)
Set the size of the embedded player.
Example:
Set the maximum embedded player width to 300 pixels
/ensemble/plugin/plugin.aspx?maxContentWidth=300

 

Filtering and Sorting Parameters

  • categoryID
Specifies the category ID by which to filter the video list.
You can obtain the category ID by clicking on the "i" icon in the "Categories" screen of the Ensemble Video administrative panel.
Example:
Show only videos for the category with ID "bXSAhBEhAkqCM-WEWAut8Q"
/ensemble/plugin/plugin.aspx?categoryID=bXSAhBEhAkqCM-WEWAut8Q
  • categoryName
Specifies the category name by which to filter the video list.
Example:
Show only videos for the category with name "Default Category"
/ensemble/plugin/plugin.aspx?categoryName=Default%20Category
  • searchByString = Any search keyword
Filters the list of videos to only show vidoes that have a matching string the title, abstract or keywords.
Example:
Show only videos for which the title, abstract or keyword contain the word "test"
/ensemble/plugin/plugin.aspx?searchString=test
  • orderBy = defaults to "videoDate"
Specifies the column by which the video list will be sorted. This parameter works in conjunction with the orderByDirection parameter.
Possible values: videoID, videoDate, videoDateProduced, videoDescription, videoTitle, videoDuration, videoKeywords, viewCount
Example:
Order the video list in ascending order by the videoTitle
/ensemble/plugin/plugin.aspx?orderBy=videoTitle&orderByDirection=asc
  • orderByDirection = asc/desc (defaults to "desc")
Specifies the sort order of the video list. This parameter works in conjunction with the orderBy parameter.
Possible values: asc (ascending), desc (descending)
Example:
Order the video list in ascending order by the videoDuration
/ensemble/plugin/plugin.aspx?orderBy=videoDuration&orderByDirection=asc
  • pageIndex = Any whole integer (defaults to 1)
Specifies the index number of the current page when paging is used. Used in conjunction with the pageSize parameter.
Example:
Show the first page of videos with 20 videos per page
/ensemble/plugin/plugin.aspx?pageIndex=1&pageSize=20
  • pageSize = Any whole integer (defaults to 10)
Specifies the number of videos to list per page when paging is used. Used in conjunction with the pageIndex parameter.
Example:
Show the second page of videos with 15 video per page
/ensemble/plugin/plugin.aspx?pageIndex=2&pageSize=15
  • resultsCount
Specifies the the number of videos to show in the video list. Similar to pageSize but limits the number of videos returned by the server.
Example:
Show only the top 2 videos sorted by ascending date
/ensemble/plugin/plugin.aspx?resultsCount=2&orderBy=videoDate&orderByDirection=desc
1 out of 1 found this helpful
Newsletter Sign-Up

Articles in this section

See more