For developers: Query videos
This topic explains how to query instances of videos. The examples below show you how to query all of the available videos or how to query only a specific video by its ID.
NOTE: The code examples below work with the ID of the master version of the video and return the live version of the video. For more information about other scenarios, see For developers: Query master and live versions.
Query a single video
When querying the live version of a specific video by the ID of its master version, you must perform the following:
- Get the master version.
First, get an instance of the master version with the specified ID.
- Get the live version.
The instance that corresponds to the ID argument is the master version of the video. You must get the live version explicitly.
NOTE: The live version is used only when displaying the video in a front-end scenario. If you want to manipulate the video, consider using the master version. To transfer the changes to the live version, publish the master version.
- Return the live version.
The following code queries the live version of a video by the ID of its master version.
Native API
First, you get an instance of the LibrariesManager class. You get the specified video by querying all videos and filtering the collection by the ID property of the video. If the video exists, you get its live version. If no live version exists (i.e. the item has not been published), you return null. Finally, you return the live version.
You can also use the following code to retrieve the video:
NOTE: When the video does not exist, an exception of type ItemNotFoundException is thrown.
Fluent API
First, you get the singular video facade of the master version with the specified ID. Then, to load the live version of the video, you call the GetLive method of the facade. Finally, to get the instance of the live version, you call the Get method.
Query videos by a video library
To query videos by a video library, you must perform the following:
- Get the libraries manager.
Get an instance of the LibrariesManager object.
- Get the video library.
Get an instance of the specified video library.
- Get the videos.
Get the videos by calling the Videos extension method of the VideoLibrary instance. This extension method is located in the Telerik.Sitefinity.Modules.Libraries namespace.
NOTE: Another way of getting the videos from a specific library, is to query all the videos and filter the collection by the ID of the video library. You can find an example of this approach in the next section.
Use the following code samples:
Native API
Fluent API
Query all videos
When querying all videos, you must perform the following:
- Query all videos.
First, get a query of all available videos. The query includes all live, master and temp versions.
- Filter the query.
Filter the query to return only the live versions.
- Get the videos.
Get the filtered videos in a list.
- Return the videos.
The following code queries all published videos:
NOTE: You can filter the query to get a specific set of videos. For example, you can get the videos from a specific library:
In this code example you additionally filter the collection by the ID of the parent video library.
NOTE: You can filter the query to get a specific set of videos. For example, you can get the videos from a specific library:
In this code example you use the plural facade for the videos and filter them by the ID of the specified video library. Then, you get the live versions of the selected videos.