C# Class Granicus.MediaManager.SDK.MediaManager

Inheritance: System.Web.Services.Protocols.SoapHttpClientProtocol, IMediaManager

Afficher le fichier Open project: Granicus/platform-api-net Class Usage Examples

Méthodes publiques

Méthode	Description
Connect ( string Server, string Username, string Password ) : void	Used to initially connect to MediaManager. Before other methods can be called on a MediaManager object, the Connect method must be called. If Connect has not been called, and the MediaManager object was not instantiated using an overload that supports automated logon, then an exception will be thrown whenever another method is called on the MediaManager object.
ConvertToMetaTree ( MetaDataData &MetaData ) : void	Converts a list of metadata as returned by GetClipMetaData or GetEventMetaData and converts it to tree form that can be used to write back into MediaManager via ImportClipMetaData or ImportEventMetaData.
ConvertToMetaTree ( MetaDataDataCollection &MetaData ) : void	Converts a list of metadata as returned by GetClipMetaData or GetEventMetaData and converts it to tree form that can be used to write back into MediaManager via ImportClipMetaData or ImportEventMetaData.
Disconnect ( ) : void	Disconnects the MediaManager instance from the MediaManager web application. Once disconnect has been called you must call Granicus.MediaManager.SDK.MediaManager.Connect before the MediaManager instance is usable again.
GetMediaVault ( ServerInterfaceData ServerInterface ) : MediaVault	Returns a usable MediaVault object for the given ServerInterface. This method should be used to connect to a given MediaVault. While it is possible to connect by instantiating a new Granicus.MediaManager.SDK.MediaVault object and manually connecting it, it is not recommended.
GetMediaVault ( int FolderID ) : MediaVault	Returns a usable MediaVault object for the given Folder ID. This method should be used to connect to a given MediaVault. While it is possible to connect by instantiating a new Granicus.MediaManager.SDK.MediaVault object and manually connecting it, it is not recommended.
GetOutcastEncoder ( CameraData Camera ) : OutcastEncoder	Returns a usable OutcastEncoder object for the given camera. This method should be used to connect to a given Outcast Encoder. While it is possible to connect by instantiating a new Granicus.MediaManager.SDK.OutcastEncoder object and manually connecting it, it is not recommended.
GetOutcastEncoder ( int CameraID ) : OutcastEncoder	Returns a usable OutcastEncoder object for the given CameraID This method should be used to connect to a given Outcast Encoder. While it is possible to connect by instantiating a new Granicus.MediaManager.SDK.OutcastEncoder object and manually connecting it, it is not recommended.
Impersonate ( string Server, string ImpersonationToken ) : void	Allows impersonation of a given user via the use of an ImpersonationToken. Impersonation allows you to connect to an existing MediaManager session using an ImpersonationToken. In order to be valid, the ImpersonationToken must be from a currently logged on session. If the user has logged off, the impersonation token will be rendered invalid immediately.
ImportClipMetaData ( int ClipID, MetaDataDataCollection MetaData, bool ClearExisting, bool AsTree ) : KeyMapping[]	Imports an entire tree off metadata into the root level of the given clip.
ImportEventMetaData ( int EventID, MetaDataDataCollection MetaData, bool ClearExisting, bool AsTree ) : KeyMapping[]	Imports an entire tree off metadata into the root level of the given event.
MediaManager ( ) : System	Initializes a new instance of the Granicus.MediaManager.SDK.MediaManager class. This constructor does not connect you to an instance of MediaManager and therefore is not usable until the Granicus.MediaManager.SDK.MediaManager.Connect method has been called.
MediaManager ( string Server, string Username, string Password ) : System	Initializes a new instance of the Granicus.MediaManager.SDK.MediaManager class and connects it to the provided MediaManager site.
SendChallengeResponse ( string key, System.DateTime expiration ) : void
ServerConnect ( string Server, string key, System.DateTime expiration ) : void	Used to initially connect to MediaManager. Before other methods can be called on a MediaManager object, the Connect method must be called. If Connect has not been called, and the MediaManager object was not instantiated using an overload that supports automated logon, then an exception will be thrown whenever another method is called on the MediaManager object.

Méthodes protégées

Méthode	Description
GetWebRequest ( Uri uri ) : WebRequest

Private Methods

Méthode	Description
AddClipMetaData ( int ClipID, MetaDataData MetaDataData ) : KeyMapping[]
AddEventMetaData ( int EventID, MetaDataData MetaDataData ) : KeyMapping[]
CreateAttendees ( Attendee AttendeesData ) : void
CreateCamera ( CameraData CameraData ) : int
CreateEvent ( EventData EventData ) : int
CreateFolder ( FolderData FolderData ) : int
CreateGroup ( GroupData GroupData ) : int
CreateMotionActions ( StringCollection motionActions ) : void
CreateServer ( ServerData ServerData ) : int
CreateTemplate ( TemplateData TemplateData ) : int
CreateUser ( UserData UserData ) : string
CreateView ( ViewData ViewData ) : int
DeleteCamera ( int CameraID ) : void
DeleteClip ( int ClipID ) : void
DeleteEvent ( int EventID ) : void
DeleteFolder ( int FolderID ) : void
DeleteGroup ( int GroupID ) : void
DeleteMetaData ( int MetaDataID ) : void
DeleteMinutesDocument ( string UID ) : void
DeleteServer ( int ServerID ) : void
FetchAttachment ( int MetaDataID ) : Document
GetCamera ( int CameraID ) : CameraData
GetCameraVideoLocation ( int CameraID ) : string
GetCameras ( ) : CameraData[]
GetChallenge ( string ChallengeCode ) : string
GetClip ( int ClipID ) : ClipData
GetClipByUID ( string ClipUID ) : ClipData
GetClipCaptions ( int ClipID ) : string
GetClipCaptionsByUID ( string ClipUID ) : string
GetClipIndices ( int ClipID ) : MetaDataData[]
GetClipIndicesByUID ( string ClipUID ) : MetaDataData[]
GetClipMetaData ( int ClipID ) : MetaDataData[]
GetClipMetaDataByUID ( string ClipUID ) : MetaDataData[]
GetClipMinutesDocuments ( int ClipID ) : MinutesDocumentData[]
GetClipVideoLocation ( int ClipID ) : string
GetClips ( int FolderID ) : ClipData[]
GetClipsByForeignID ( int ForeignID ) : ClipData[]
GetCurrentUserID ( ) : int
GetCurrentUserLogon ( ) : string
GetCurrentUserUID ( ) : string
GetEvent ( int EventID ) : EventData
GetEventByUID ( string EventUID ) : EventData
GetEventMetaData ( int EventID ) : MetaDataData[]
GetEventMetaDataByUID ( string EventUID ) : MetaDataData[]
GetEventVideoLocation ( int EventID ) : string
GetEventVideoLocationByUID ( string EventUID ) : string
GetEvents ( ) : EventData[]
GetEventsByDateRange ( System.DateTime StartTime, System.DateTime EndTime ) : EventData[]
GetEventsByForeignID ( int ForeignID ) : EventData[]
GetFolder ( int FolderID ) : FolderData
GetFolderUploadInterface ( int FolderID ) : ServerInterfaceData
GetFolders ( ) : FolderData[]
GetFoldersByType ( string Type ) : FolderData[]
GetGroup ( int GroupID ) : GroupData
GetGroups ( ) : GroupData[]
GetMetaData ( int MetaDataID ) : MetaDataData
GetMetaDataByUID ( string MetaDataUID ) : MetaDataData
GetMetaDataVideoLocation ( int MetaDataID ) : string
GetMotionActions ( ) : StringCollection
GetPermissionLevel ( string AssetType, int AssetID ) : int
GetServer ( int ServerID ) : ServerData
GetServers ( ) : ServerData[]
GetTemplate ( int TemplateID ) : TemplateData
GetTemplates ( ) : TemplateData[]
GetUser ( string UserUID ) : UserData
GetUsers ( ) : UserData[]
GetView ( int ViewID ) : ViewData
GetViews ( ) : ViewData[]
ImportClipMetaData ( int ClipID, MetaDataData MetaData, bool ClearExisting, bool AsTree ) : KeyMapping[]
ImportEventMetaData ( int EventID, MetaDataData MetaData, bool ClearExisting, bool AsTree ) : KeyMapping[]
LogMessage ( string Message, string Application, string Class, int Priority ) : int
Login ( string Username, string Password ) : void
Logout ( ) : void
PublishClip ( PublishClipData PublishClipData ) : PublishClipResult
RegisterClipUpload ( ClipData ClipData, int ServerID ) : int
SendChallengeResponse ( string Challenge, string Response ) : void
SetClipAgendaURL ( int ClipID, string URL ) : void
SetClipMinutesURL ( int ClipID, string URL ) : void
SetClipMinutesURLWithName ( int ClipID, string URL, string Name ) : void
SetEventAgendaURL ( int EventID, string URL ) : void
SetEventAgendaURLByUID ( string EventUID, string URL ) : void
SetUserMemberships ( string UserUID, string GroupUIDs ) : void
UpdateCamera ( CameraData camera ) : void
UpdateClip ( ClipData clip ) : void
UpdateEvent ( EventData @event ) : void
UpdateFolder ( FolderData folder ) : void
UpdateGroup ( GroupData group ) : void
UpdateMetaData ( MetaDataData MetaData ) : void
UpdateServer ( ServerData server ) : void
UpdateTemplate ( TemplateData template ) : void
UpdateUser ( UserData user ) : void
UpdateView ( ViewData view ) : void
UploadClipMinutesDocument ( int ClipID, Document Document, string Name ) : void
UploadEventAgendaDocument ( int EventID, Document Document ) : void
UploadEventAgendaDocumentByUID ( string EventUID, Document Document ) : void
m_BuildMetaBranch ( MetaDataData metalist, int ParentID ) : MetaDataDataCollection	Recursively builds a metadata tree from the contents of an array of metadata.
m_BuildMetaBranch ( MetaDataDataCollection metalist, int ParentID ) : MetaDataDataCollection	Recursively builds a metadata tree from the contents of an array of metadata.
m_SafeServerURL ( string Server ) : string	Converts server name (i.e. streaming.granicus.com) into complete url useful to base webservices.

Method Details

Connect() public méthode

Used to initially connect to MediaManager.

Before other methods can be called on a MediaManager object, the Connect method must be called. If Connect has not been called, and the MediaManager object was not instantiated using an overload that supports automated logon, then an exception will be thrown whenever another method is called on the MediaManager object.

public Connect ( string Server, string Username, string Password ) : void
Server	string	The MediaManager Host to connect to (e.g. client.granicus.com)
Username	string	The MediaManager username to connect with.
Password	string	The MediaManager password for the given username.
Résultat	void

ConvertToMetaTree() public méthode

Converts a list of metadata as returned by GetClipMetaData or GetEventMetaData and converts it to tree form that can be used to write back into MediaManager via ImportClipMetaData or ImportEventMetaData.

public ConvertToMetaTree ( MetaDataData &MetaData ) : void
MetaData	MetaDataData	The array of metadata to be converted to tree form.
Résultat	void

ConvertToMetaTree() public méthode

public ConvertToMetaTree ( MetaDataDataCollection &MetaData ) : void
MetaData	MetaDataDataCollection	The collection of metadata to be converted to tree form.
Résultat	void

Disconnect() public méthode

Disconnects the MediaManager instance from the MediaManager web application.

Once disconnect has been called you must call Granicus.MediaManager.SDK.MediaManager.Connect before the MediaManager instance is usable again.

public Disconnect ( ) : void
Résultat	void

GetMediaVault() public méthode

Returns a usable MediaVault object for the given ServerInterface.

This method should be used to connect to a given MediaVault. While it is possible to connect by instantiating a new Granicus.MediaManager.SDK.MediaVault object and manually connecting it, it is not recommended.

public GetMediaVault ( ServerInterfaceData ServerInterface ) : MediaVault
ServerInterface	ServerInterfaceData	The ServerInterfaceData object for the desired MediaVault connection.
Résultat	MediaVault

GetMediaVault() public méthode

Returns a usable MediaVault object for the given Folder ID.

public GetMediaVault ( int FolderID ) : MediaVault
FolderID	int	The ID of the Folder that the MediaVault object must have access to.
Résultat	MediaVault

GetOutcastEncoder() public méthode

Returns a usable OutcastEncoder object for the given camera.

This method should be used to connect to a given Outcast Encoder. While it is possible to connect by instantiating a new Granicus.MediaManager.SDK.OutcastEncoder object and manually connecting it, it is not recommended.

public GetOutcastEncoder ( CameraData Camera ) : OutcastEncoder
Camera	CameraData	The CameraData object for the desired OutcastEncoder.
Résultat	OutcastEncoder

GetOutcastEncoder() public méthode

Returns a usable OutcastEncoder object for the given CameraID

public GetOutcastEncoder ( int CameraID ) : OutcastEncoder
CameraID	int	The numeric ID of the desired OutcastEncoder.
Résultat	OutcastEncoder

GetWebRequest() protected méthode

protected GetWebRequest ( Uri uri ) : WebRequest
uri	System.Uri
Résultat	System.Net.WebRequest

Impersonate() public méthode

Allows impersonation of a given user via the use of an ImpersonationToken.

Impersonation allows you to connect to an existing MediaManager session using an ImpersonationToken. In order to be valid, the ImpersonationToken must be from a currently logged on session. If the user has logged off, the impersonation token will be rendered invalid immediately.

public Impersonate ( string Server, string ImpersonationToken ) : void
Server	string	The MediaManager site (e.g. client.granicus.com) on which to impersonate the given user.
ImpersonationToken	string	The impersonation token of the currently logged on user that is to be impersonated.
Résultat	void

ImportClipMetaData() public méthode

Imports an entire tree off metadata into the root level of the given clip.

public ImportClipMetaData ( int ClipID, MetaDataDataCollection MetaData, bool ClearExisting, bool AsTree ) : KeyMapping[]
ClipID	int	The numeric Clip ID to place the metadata tree on.
MetaData	MetaDataDataCollection	A MetaDataDataCollection that represents the entire tree.
ClearExisting	bool	Whether or not to clear the existing metadata for the clip (this is usually True).
AsTree	bool	Whether or not the data is formed into a tree (this is almost always True).
Résultat	KeyMapping[]

ImportEventMetaData() public méthode

Imports an entire tree off metadata into the root level of the given event.

public ImportEventMetaData ( int EventID, MetaDataDataCollection MetaData, bool ClearExisting, bool AsTree ) : KeyMapping[]
EventID	int	The numeric Event ID to place the metadata tree on.
MetaData	MetaDataDataCollection	A MetaDataDataCollection that represents the entire tree.
ClearExisting	bool	Whether or not to clear the existing metadata for the event (this is usually True).
AsTree	bool	Whether or not the data is formed into a tree (this is almost always True).
Résultat	KeyMapping[]

MediaManager() public méthode

Initializes a new instance of the Granicus.MediaManager.SDK.MediaManager class.

This constructor does not connect you to an instance of MediaManager and therefore is not usable until the Granicus.MediaManager.SDK.MediaManager.Connect method has been called.

public MediaManager ( ) : System
Résultat	System

MediaManager() public méthode

Initializes a new instance of the Granicus.MediaManager.SDK.MediaManager class and connects it to the provided MediaManager site.

public MediaManager ( string Server, string Username, string Password ) : System
Server	string	The MediaManager site (e.g. client.granicus.com) to connect to.
Username	string	The username (e.g. johnsmith) to connect with.
Password	string	The password (e.g. secret) that matches the given username record.
Résultat	System

SendChallengeResponse() public méthode

public SendChallengeResponse ( string key, System.DateTime expiration ) : void
key	string
expiration	System.DateTime
Résultat	void

ServerConnect() public méthode

Used to initially connect to MediaManager.

public ServerConnect ( string Server, string key, System.DateTime expiration ) : void
Server	string	The MediaManager Host to connect to (e.g. client.granicus.com)
key	string
expiration	System.DateTime
Résultat	void