C# Class KSUtil.Metadata

Metadata class which contains supporting functions to access/update/remove metadata from an event file
显示文件 Open project: angelaHillier/KSUtil

Public Methods

Method Description
ConvertMetadataValueToString ( object metadataValue ) : string

Converts a metadata value to a string
UpdateFileMetadata ( KStudioClient client, string fileName, KStudioMetadataType type, string key, object value ) : string

Updates (adds/edits) file-level metadata in an event file
UpdateStreamMetadata ( KStudioClient client, string fileName, string streamName, KStudioMetadataType type, string key, object value ) : string

Updates (add/edits) stream-level metadata in an event file

Private Methods

Method Description
AlterMetadata ( KStudioMetadata metadata, string key, object value ) : void

Alters (add/edit/remove) a metadata item within a KStudioMetadata object
GetMetadataAsText ( KStudioMetadata metadata, KStudioMetadataType type, string streamName ) : string

Returns all key/value pairs in a metadata object as a single string

Method Details

ConvertMetadataValueToString() public static method

Converts a metadata value to a string
public static ConvertMetadataValueToString ( object metadataValue ) : string
metadataValue object Value to convert
return string

UpdateFileMetadata() public static method

Updates (adds/edits) file-level metadata in an event file
public static UpdateFileMetadata ( KStudioClient client, string fileName, KStudioMetadataType type, string key, object value ) : string
client KStudioClient KStudioClient to use for accessing the event file
fileName string Path to event file
type KStudioMetadataType Type of metadata (Public or Personal)
key string Key of metadata object to add/edit
value object Value of metadata object to add/edit
return string

UpdateStreamMetadata() public static method

Updates (add/edits) stream-level metadata in an event file
public static UpdateStreamMetadata ( KStudioClient client, string fileName, string streamName, KStudioMetadataType type, string key, object value ) : string
client KStudioClient KStudioClient to use for accessing the event file
fileName string Path to event file
streamName string Name of stream which should contain the metadata
type KStudioMetadataType Type of metadata to update (Public or Personal)
key string Key of metadata object to add/edit
value object Value of metadata object to add/edit
return string