Topics

All topics

Development

Query videos
Development

This article contains
NEW TO SITEFINITY?

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:

  1. Get the master version.
    First, get an instance of the master version with the specified ID.
  2. 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.

  3. Return the live version.

The following code queries the live version of a video by the ID of its master version.

Native API

using System;
using System.Linq;
using Telerik.Sitefinity.Libraries.Model;
using Telerik.Sitefinity.Modules.Libraries;
namespace SitefinityWebApp
{
public class QueryVideos_GetVideoNativeAPI
{
private Video GetVideoNativeAPI(Guid masterVideoId)
{
LibrariesManager librariesManager = LibrariesManager.GetManager();
Video video = librariesManager.GetVideos().Where(d => d.Id == masterVideoId).FirstOrDefault();
if (video != null)
{
video = librariesManager.Lifecycle.GetLive(video) as Video;
}
return video;
}
}
}
view raw QueryVideos_GetVideoNativeAPI.cs hosted with ❤ by GitHub

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:

using System;
using Telerik.Sitefinity.Libraries.Model;
using Telerik.Sitefinity.Modules.Libraries;
namespace SitefinityWebApp
{
public class QueryVideos_GetVideoNativeAPI2
{
private Video GetVideoNativeAPI(Guid masterVideoId)
{
LibrariesManager librariesManager = LibrariesManager.GetManager();
Video video = librariesManager.GetVideo(masterVideoId);
if (video != null)
{
video = librariesManager.Lifecycle.GetLive(video) as Video;
}
return video;
}
}
}
view raw QueryVideos_GetVideoNativeAPI2.cs hosted with ❤ by GitHub

NOTE: When the video does not exist, an exception of type ItemNotFoundException is thrown.

Fluent API

using System;
using Telerik.Sitefinity;
using Telerik.Sitefinity.Libraries.Model;
namespace SitefinityWebApp
{
public class QueryVideos_GetVideoFluentAPI
{
private Video GetVideoFluentAPI(Guid masterVideoId)
{
return App.WorkWith().Video(masterVideoId).GetLive().Get();
}
}
}
view raw QueryVideos_GetVideoFluentAPI.cs hosted with ❤ by GitHub

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:

  1. Get the libraries manager.
    Get an instance of the LibrariesManager object.
  2. Get the video library.
    Get an instance of the specified video library.
  3. 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

using System;
using System.Linq;
using Telerik.Sitefinity.GenericContent.Model;
using Telerik.Sitefinity.Libraries.Model;
using Telerik.Sitefinity.Modules.Libraries;
namespace SitefinityWebApp
{
public class QueryVideos_GetVideosByVideoLibraryNativeAPI
{
public static IQueryable<Video> GetVideosByVideoLibraryNativeAPI(Guid videoLibraryId)
{
LibrariesManager librariesManager = LibrariesManager.GetManager();
VideoLibrary videoLibrary = librariesManager.GetVideoLibrary(videoLibraryId);
return videoLibrary.Videos().Where(v => v.Status == ContentLifecycleStatus.Live);
}
}
}
view raw QueryVideos_GetVideosByVideoLibraryNativeAPI.cs hosted with ❤ by GitHub

Fluent API

using System;
using System.Linq;
using Telerik.Sitefinity;
using Telerik.Sitefinity.GenericContent.Model;
using Telerik.Sitefinity.Libraries.Model;
namespace SitefinityWebApp
{
public class QueryVideos_GetVideosByVideoLibraryFluentAPI
{
public static IQueryable<Video> GetVideosByVideoLibraryFluentAPI(Guid videoLibraryId)
{
return App.WorkWith().VideoLibrary(videoLibraryId).Videos().Where(d => d.Status == ContentLifecycleStatus.Live && d.Visible).Get();
}
}
}
view raw QueryVideos_GetVideosByVideoLibraryFluentAPI.cs hosted with ❤ by GitHub

Query all videos

When querying all videos, you must perform the following:

  1. Query all videos.
    First, get a query of all available videos. The query includes all live, master and temp versions.
  2. Filter the query.
    Filter the query to return only the live versions.
  3. Get the videos.
    Get the filtered videos in a list.
  4. Return the videos.

The following code queries all published videos:

using System;
using System.Collections.Generic;
using System.Linq;
using Telerik.Sitefinity.GenericContent.Model;
using Telerik.Sitefinity.Libraries.Model;
using Telerik.Sitefinity.Modules.Libraries;
namespace SitefinityWebApp
{
public class QueryVideos_GetAllVideosByVideoLibraryNativeAPI
{
private List<Video> GetAllVideosByVideoLibraryNativeAPI(Guid videoLibraryId)
{
LibrariesManager librariesManager = LibrariesManager.GetManager();
return librariesManager.GetVideos().Where(d => d.Status == ContentLifecycleStatus.Live && d.Visible && d.Parent.Id == videoLibraryId).ToList();
}
}
}
view raw QueryVideos_GetAllVideosByVideoLibraryNativeAPI.cs hosted with ❤ by GitHub

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:

using System;
using System.Collections.Generic;
using System.Linq;
using Telerik.Sitefinity;
using Telerik.Sitefinity.GenericContent.Model;
using Telerik.Sitefinity.Libraries.Model;
namespace SitefinityWebApp
{
public class QueryVideos_GetAllVideosByVideoLibraryFluentAPI
{
public static List<Video> GetAllVideosByVideoLibraryFluentAPI(Guid videoLibraryId)
{
return App.WorkWith().Videos().Where(v => v.Parent.Id == videoLibraryId && v.Status == ContentLifecycleStatus.Live && v.Visible).Get().ToList();
}
}
}
view raw QueryVideos_GetAllVideosByVideoLibraryFluentAPI.cs hosted with ❤ by GitHub

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.

Want to learn more?

Increase your Sitefinity skills by signing up for our free trainings. Get Sitefinity-certified at Progress Education Community to boost your credentials.

Get started with Integration Hub | Sitefinity Cloud | Sitefinity SaaS

This free lesson teaches administrators, marketers, and other business professionals how to use the Integration hub service to create automated workflows between Sitefinity and other business systems.

Web Security for Sitefinity Administrators

This free lesson teaches administrators the basics about protecting yor Sitefinity instance and its sites from external threats. Configure HTTPS, SSL, allow lists for trusted sites, and cookie security, among others.

Foundations of Sitefinity ASP.NET Core Development

The free on-demand video course teaches developers how to use Sitefinity .NET Core and leverage its decoupled architecture and new way of coding against the platform.

Was this article helpful?

Next article

Modify videos