IMobileMediaService.GetMetadataInfo Method

Article
10/17/2012

[IMobileMediaService.GetMetadataInfo is no longer available for use as of Windows Server 2012 Essentials.] Returns media metadata by using specified grouping and filtering criteria.

Namespace: Microsoft.WindowsServerSolutions.Mobile.Web.Media
Assembly: MobileWeb (in MobileWeb.dll)

Usage

'Usage
Dim instance As IMobileMediaService
Dim mediaTypeData As String
Dim groupingMethodData As String
Dim groupingData As String
Dim startingIndexData As String
Dim requestedCountData As String
Dim sortPropertyData As String
Dim sortOrderData As String
Dim isThumbnailViewData As String
Dim returnValue As MetadataResult

returnValue = instance.GetMetadataInfo(mediaTypeData, groupingMethodData, groupingData, startingIndexData, requestedCountData, sortPropertyData, sortOrderData, isThumbnailViewData)

Syntax

'Declaration
<OperationContractAttribute> _
Function GetMetadataInfo ( _
    mediaTypeData As String, _
    groupingMethodData As String, _
    groupingData As String, _
    startingIndexData As String, _
    requestedCountData As String, _
    sortPropertyData As String, _
    sortOrderData As String, _
    isThumbnailViewData As String _
) As MetadataResult

[OperationContractAttribute] 
MetadataResult GetMetadataInfo (
    string mediaTypeData,
    string groupingMethodData,
    string groupingData,
    string startingIndexData,
    string requestedCountData,
    string sortPropertyData,
    string sortOrderData,
    string isThumbnailViewData
)

[OperationContractAttribute] 
MetadataResult^ GetMetadataInfo (
    String^ mediaTypeData, 
    String^ groupingMethodData, 
    String^ groupingData, 
    String^ startingIndexData, 
    String^ requestedCountData, 
    String^ sortPropertyData, 
    String^ sortOrderData, 
    String^ isThumbnailViewData
)

/** @attribute OperationContractAttribute() */ 
MetadataResult GetMetadataInfo (
    String mediaTypeData, 
    String groupingMethodData, 
    String groupingData, 
    String startingIndexData, 
    String requestedCountData, 
    String sortPropertyData, 
    String sortOrderData, 
    String isThumbnailViewData
)

OperationContractAttribute 
function GetMetadataInfo (
    mediaTypeData : String, 
    groupingMethodData : String, 
    groupingData : String, 
    startingIndexData : String, 
    requestedCountData : String, 
    sortPropertyData : String, 
    sortOrderData : String, 
    isThumbnailViewData : String
) : MetadataResult

Parameters

mediaTypeData
Media type. This can be one of the following values.

Value

Description

Photo

Searches photo media.

Music

Searches music media.

Video

Searches video media.

groupingMethodData
Used with the mediaTypeData parameter to additionally specify the scope of the search.

groupingMethodData value	mediaTypeData value	Description
Folder	Photo	Returns results for photos whose folder name matches the specified search criteria.
Date	Photo	Returns results for photos whose date matches the specified search criteria.
Tags	Photo	Returns results photos whose tag value matches the specified search criteria. Multiple tags are separated by spaces.
AlbumArtist	Music	Returns results for music whose album name matches the specified search criteria.
Artist	Music	Returns results for music whose artist name matches the specified search criteria.
Genre	Music	Returns results for music whose genre value matches the specified search criteria.
Playlist	Music	Returns results for music whose playlist value matches the specified search criteria.
All	Music	Returns results for all music.
Folder	Video	Returns results for videos whose folder name matches the specified search criteria.
All	Video	Returns results for all videos.

groupingData
Defined search scope in the groupingMethodData.

startingIndexData
Index from which to begin retrieving data.

requestedCountData
Number of metadata items to return.

sortPropertyData
Property to sort by. This can be one of the following values.

Value

Description

Title

Sorts by the media title.

Date

Sorts by the media creation date.

Tags

Sorts by the media tag value. Multiple tags are separated by spaces.

sortOrderData
Sort order. This can be one of the following values.

Value

Description

ASC

Sorts in ascending order.

DESC

Sorts in descending order.

isThumbnailViewData
Specifies whether the metadata represents thumbnail data.

Return Value

Returns MetadataResult.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows Server 2008 R2 x64, Windows 7 x64, Windows Server 2008 x64, Windows Vista x64