C# Class OpenHome.Net.ControlPoint.Proxies.CpProxyUpnpOrgContentDirectory1

Proxy for the upnp.org:ContentDirectory:1 UPnP service
Inheritance: OpenHome.Net.ControlPoint.CpProxy, IDisposable, ICpProxyUpnpOrgContentDirectory1
Afficher le fichier Open project: stoennies/raumwiese Class Usage Examples

Méthodes publiques

Méthode Description
BeginAddContainerToQueue ( String aQueueID, String aContainerID, String aSourceID, String aSearchCriteria, String aSortCriteria, uint aStartIndex, uint aEndIndex, uint aPosition, CallbackAsyncComplete aCallback ) : void

Invoke the action asynchronously

Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndAddContainerToQueue().

BeginAddItemToQueue ( String aQueueID, String aObjectID, uint aPosition, CallbackAsyncComplete aCallback ) : void

Invoke the action asynchronously

Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndAddItemToQueue().

BeginBrowse ( String aObjectID, String aBrowseFlag, String aFilter, uint aStartingIndex, uint aRequestedCount, String aSortCriteria, CallbackAsyncComplete aCallback ) : void

Invoke the action asynchronously

Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndBrowse().

BeginCreateQueue ( String aDesiredName, String aContainerID, CallbackAsyncComplete aCallback ) : void

Invoke the action asynchronously

Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndCreateQueue().

BeginCreateReference ( String aContainerID, String aObjectID, CallbackAsyncComplete aCallback ) : void

Invoke the action asynchronously

Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndCreateReference().

BeginDestroyObject ( String aObjectID, CallbackAsyncComplete aCallback ) : void

Invoke the action asynchronously

Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndDestroyObject().

BeginGetIndexerStatus ( CallbackAsyncComplete aCallback ) : void

Invoke the action asynchronously

Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndGetIndexerStatus().

BeginGetSearchCapabilities ( CallbackAsyncComplete aCallback ) : void

Invoke the action asynchronously

Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndGetSearchCapabilities().

BeginGetSortCapabilities ( CallbackAsyncComplete aCallback ) : void

Invoke the action asynchronously

Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndGetSortCapabilities().

BeginGetSourceInfo ( String aSourceID, CallbackAsyncComplete aCallback ) : void

Invoke the action asynchronously

Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndGetSourceInfo().

BeginGetSystemUpdateID ( CallbackAsyncComplete aCallback ) : void

Invoke the action asynchronously

Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndGetSystemUpdateID().

BeginMoveInQueue ( String aObjectID, uint aNewPosition, CallbackAsyncComplete aCallback ) : void

Invoke the action asynchronously

Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndMoveInQueue().

BeginQueryDatabaseState ( CallbackAsyncComplete aCallback ) : void

Invoke the action asynchronously

Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndQueryDatabaseState().

BeginRemoveFromQueue ( String aQueueID, uint aFromPosition, uint aToPosition, CallbackAsyncComplete aCallback ) : void

Invoke the action asynchronously

Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndRemoveFromQueue().

BeginRenameQueue ( String aQueueID, String aDesiredName, CallbackAsyncComplete aCallback ) : void

Invoke the action asynchronously

Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndRenameQueue().

BeginRescanSource ( String aSourceID, String aRescanMode, CallbackAsyncComplete aCallback ) : void

Invoke the action asynchronously

Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndRescanSource().

BeginResetDatabase ( String aScope, CallbackAsyncComplete aCallback ) : void

Invoke the action asynchronously

Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndResetDatabase().

BeginSearch ( String aContainerID, String aSearchCriteria, String aFilter, uint aStartingIndex, uint aRequestedCount, String aSortCriteria, CallbackAsyncComplete aCallback ) : void

Invoke the action asynchronously

Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndSearch().

BeginShuffle ( String aContainerID, String aSelection, CallbackAsyncComplete aCallback ) : void

Invoke the action asynchronously

Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndShuffle().

CpProxyUpnpOrgContentDirectory1 ( CpDevice aDevice ) : System

Constructor

Use CpProxy::[Un]Subscribe() to enable/disable querying of state variable and reporting of their changes.

Dispose ( ) : void

Must be called for each class instance. Must be called before Core.Library.Close().

EndAddContainerToQueue ( IntPtr aAsyncHandle ) : void

Retrieve the output arguments from an asynchronously invoked action.

This may only be called from the callback set in the above Begin function.

EndAddItemToQueue ( IntPtr aAsyncHandle ) : void

Retrieve the output arguments from an asynchronously invoked action.

This may only be called from the callback set in the above Begin function.

EndBrowse ( IntPtr aAsyncHandle, String &aResult, uint &aNumberReturned, uint &aTotalMatches, uint &aUpdateID ) : void

Retrieve the output arguments from an asynchronously invoked action.

This may only be called from the callback set in the above Begin function.

EndCreateQueue ( IntPtr aAsyncHandle, String &aGivenName, String &aQueueID, String &aMetaData ) : void

Retrieve the output arguments from an asynchronously invoked action.

This may only be called from the callback set in the above Begin function.

EndCreateReference ( IntPtr aAsyncHandle, String &aNewID ) : void

Retrieve the output arguments from an asynchronously invoked action.

This may only be called from the callback set in the above Begin function.

EndDestroyObject ( IntPtr aAsyncHandle ) : void

Retrieve the output arguments from an asynchronously invoked action.

This may only be called from the callback set in the above Begin function.

EndGetIndexerStatus ( IntPtr aAsyncHandle, String &aStatus ) : void

Retrieve the output arguments from an asynchronously invoked action.

This may only be called from the callback set in the above Begin function.

EndGetSearchCapabilities ( IntPtr aAsyncHandle, String &aSearchCaps ) : void

Retrieve the output arguments from an asynchronously invoked action.

This may only be called from the callback set in the above Begin function.

EndGetSortCapabilities ( IntPtr aAsyncHandle, String &aSortCaps ) : void

Retrieve the output arguments from an asynchronously invoked action.

This may only be called from the callback set in the above Begin function.

EndGetSourceInfo ( IntPtr aAsyncHandle, uint &aNumTracks, uint &aTotalSize, uint &aTotalDuration, uint &aScanProgress, String &aIndexerResult ) : void

Retrieve the output arguments from an asynchronously invoked action.

This may only be called from the callback set in the above Begin function.

EndGetSystemUpdateID ( IntPtr aAsyncHandle, uint &aId ) : void

Retrieve the output arguments from an asynchronously invoked action.

This may only be called from the callback set in the above Begin function.

EndMoveInQueue ( IntPtr aAsyncHandle, uint &aContainerUpdateID ) : void

Retrieve the output arguments from an asynchronously invoked action.

This may only be called from the callback set in the above Begin function.

EndQueryDatabaseState ( IntPtr aAsyncHandle, uint &aCurrentNumResources, uint &aCriticalNumResources, uint &aCurrentDiskUsage, uint &aMaxDiskUsage ) : void

Retrieve the output arguments from an asynchronously invoked action.

This may only be called from the callback set in the above Begin function.

EndRemoveFromQueue ( IntPtr aAsyncHandle, uint &aContainerUpdateID ) : void

Retrieve the output arguments from an asynchronously invoked action.

This may only be called from the callback set in the above Begin function.

EndRenameQueue ( IntPtr aAsyncHandle, String &aGivenName ) : void

Retrieve the output arguments from an asynchronously invoked action.

This may only be called from the callback set in the above Begin function.

EndRescanSource ( IntPtr aAsyncHandle ) : void

Retrieve the output arguments from an asynchronously invoked action.

This may only be called from the callback set in the above Begin function.

EndResetDatabase ( IntPtr aAsyncHandle ) : void

Retrieve the output arguments from an asynchronously invoked action.

This may only be called from the callback set in the above Begin function.

EndSearch ( IntPtr aAsyncHandle, String &aResult, uint &aNumberReturned, uint &aTotalMatches, uint &aUpdateID ) : void

Retrieve the output arguments from an asynchronously invoked action.

This may only be called from the callback set in the above Begin function.

EndShuffle ( IntPtr aAsyncHandle, String &aPlaylistID, String &aPlaylistMetadata ) : void

Retrieve the output arguments from an asynchronously invoked action.

This may only be called from the callback set in the above Begin function.

PropertyA_ARG_TYPE_Scope ( ) : String

Query the value of the A_ARG_TYPE_Scope property.

This function is threadsafe and can only be called if Subscribe() has been called and a first eventing callback received more recently than any call to Unsubscribe().

PropertyContainerUpdateIDs ( ) : String

Query the value of the ContainerUpdateIDs property.

This function is threadsafe and can only be called if Subscribe() has been called and a first eventing callback received more recently than any call to Unsubscribe().

PropertyIndexerStatus ( ) : String

Query the value of the IndexerStatus property.

This function is threadsafe and can only be called if Subscribe() has been called and a first eventing callback received more recently than any call to Unsubscribe().

PropertySystemUpdateID ( ) : uint

Query the value of the SystemUpdateID property.

This function is threadsafe and can only be called if Subscribe() has been called and a first eventing callback received more recently than any call to Unsubscribe().

SetPropertyA_ARG_TYPE_ScopeChanged ( System aA_ARG_TYPE_ScopeChanged ) : void

Set a delegate to be run when the A_ARG_TYPE_Scope state variable changes.

Callbacks may be run in different threads but callbacks for a CpProxyUpnpOrgContentDirectory1 instance will not overlap.

SetPropertyContainerUpdateIDsChanged ( System aContainerUpdateIDsChanged ) : void

Set a delegate to be run when the ContainerUpdateIDs state variable changes.

Callbacks may be run in different threads but callbacks for a CpProxyUpnpOrgContentDirectory1 instance will not overlap.

SetPropertyIndexerStatusChanged ( System aIndexerStatusChanged ) : void

Set a delegate to be run when the IndexerStatus state variable changes.

Callbacks may be run in different threads but callbacks for a CpProxyUpnpOrgContentDirectory1 instance will not overlap.

SetPropertySystemUpdateIDChanged ( System aSystemUpdateIDChanged ) : void

Set a delegate to be run when the SystemUpdateID state variable changes.

Callbacks may be run in different threads but callbacks for a CpProxyUpnpOrgContentDirectory1 instance will not overlap.

SyncAddContainerToQueue ( String aQueueID, String aContainerID, String aSourceID, String aSearchCriteria, String aSortCriteria, uint aStartIndex, uint aEndIndex, uint aPosition ) : void

Invoke the action synchronously

Blocks until the action has been processed on the device and sets any output arguments

SyncAddItemToQueue ( String aQueueID, String aObjectID, uint aPosition ) : void

Invoke the action synchronously

Blocks until the action has been processed on the device and sets any output arguments

SyncBrowse ( String aObjectID, String aBrowseFlag, String aFilter, uint aStartingIndex, uint aRequestedCount, String aSortCriteria, String &aResult, uint &aNumberReturned, uint &aTotalMatches, uint &aUpdateID ) : void

Invoke the action synchronously

Blocks until the action has been processed on the device and sets any output arguments

SyncCreateQueue ( String aDesiredName, String aContainerID, String &aGivenName, String &aQueueID, String &aMetaData ) : void

Invoke the action synchronously

Blocks until the action has been processed on the device and sets any output arguments

SyncCreateReference ( String aContainerID, String aObjectID, String &aNewID ) : void

Invoke the action synchronously

Blocks until the action has been processed on the device and sets any output arguments

SyncDestroyObject ( String aObjectID ) : void

Invoke the action synchronously

Blocks until the action has been processed on the device and sets any output arguments

SyncGetIndexerStatus ( String &aStatus ) : void

Invoke the action synchronously

Blocks until the action has been processed on the device and sets any output arguments

SyncGetSearchCapabilities ( String &aSearchCaps ) : void

Invoke the action synchronously

Blocks until the action has been processed on the device and sets any output arguments

SyncGetSortCapabilities ( String &aSortCaps ) : void

Invoke the action synchronously

Blocks until the action has been processed on the device and sets any output arguments

SyncGetSourceInfo ( String aSourceID, uint &aNumTracks, uint &aTotalSize, uint &aTotalDuration, uint &aScanProgress, String &aIndexerResult ) : void

Invoke the action synchronously

Blocks until the action has been processed on the device and sets any output arguments

SyncGetSystemUpdateID ( uint &aId ) : void

Invoke the action synchronously

Blocks until the action has been processed on the device and sets any output arguments

SyncMoveInQueue ( String aObjectID, uint aNewPosition, uint &aContainerUpdateID ) : void

Invoke the action synchronously

Blocks until the action has been processed on the device and sets any output arguments

SyncQueryDatabaseState ( uint &aCurrentNumResources, uint &aCriticalNumResources, uint &aCurrentDiskUsage, uint &aMaxDiskUsage ) : void

Invoke the action synchronously

Blocks until the action has been processed on the device and sets any output arguments

SyncRemoveFromQueue ( String aQueueID, uint aFromPosition, uint aToPosition, uint &aContainerUpdateID ) : void

Invoke the action synchronously

Blocks until the action has been processed on the device and sets any output arguments

SyncRenameQueue ( String aQueueID, String aDesiredName, String &aGivenName ) : void

Invoke the action synchronously

Blocks until the action has been processed on the device and sets any output arguments

SyncRescanSource ( String aSourceID, String aRescanMode ) : void

Invoke the action synchronously

Blocks until the action has been processed on the device and sets any output arguments

SyncResetDatabase ( String aScope ) : void

Invoke the action synchronously

Blocks until the action has been processed on the device and sets any output arguments

SyncSearch ( String aContainerID, String aSearchCriteria, String aFilter, uint aStartingIndex, uint aRequestedCount, String aSortCriteria, String &aResult, uint &aNumberReturned, uint &aTotalMatches, uint &aUpdateID ) : void

Invoke the action synchronously

Blocks until the action has been processed on the device and sets any output arguments

SyncShuffle ( String aContainerID, String aSelection, String &aPlaylistID, String &aPlaylistMetadata ) : void

Invoke the action synchronously

Blocks until the action has been processed on the device and sets any output arguments

Private Methods

Méthode Description
A_ARG_TYPE_ScopePropertyChanged ( ) : void
ContainerUpdateIDsPropertyChanged ( ) : void
IndexerStatusPropertyChanged ( ) : void
SystemUpdateIDPropertyChanged ( ) : void

Method Details

BeginAddContainerToQueue() public méthode

Invoke the action asynchronously
Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndAddContainerToQueue().
public BeginAddContainerToQueue ( String aQueueID, String aContainerID, String aSourceID, String aSearchCriteria, String aSortCriteria, uint aStartIndex, uint aEndIndex, uint aPosition, CallbackAsyncComplete aCallback ) : void
aQueueID String
aContainerID String
aSourceID String
aSearchCriteria String
aSortCriteria String
aStartIndex uint
aEndIndex uint
aPosition uint
aCallback CallbackAsyncComplete Delegate to run when the action completes. /// This is guaranteed to be run but may indicate an error
Résultat void

BeginAddItemToQueue() public méthode

Invoke the action asynchronously
Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndAddItemToQueue().
public BeginAddItemToQueue ( String aQueueID, String aObjectID, uint aPosition, CallbackAsyncComplete aCallback ) : void
aQueueID String
aObjectID String
aPosition uint
aCallback CallbackAsyncComplete Delegate to run when the action completes. /// This is guaranteed to be run but may indicate an error
Résultat void

BeginBrowse() public méthode

Invoke the action asynchronously
Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndBrowse().
public BeginBrowse ( String aObjectID, String aBrowseFlag, String aFilter, uint aStartingIndex, uint aRequestedCount, String aSortCriteria, CallbackAsyncComplete aCallback ) : void
aObjectID String
aBrowseFlag String
aFilter String
aStartingIndex uint
aRequestedCount uint
aSortCriteria String
aCallback CallbackAsyncComplete Delegate to run when the action completes. /// This is guaranteed to be run but may indicate an error
Résultat void

BeginCreateQueue() public méthode

Invoke the action asynchronously
Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndCreateQueue().
public BeginCreateQueue ( String aDesiredName, String aContainerID, CallbackAsyncComplete aCallback ) : void
aDesiredName String
aContainerID String
aCallback CallbackAsyncComplete Delegate to run when the action completes. /// This is guaranteed to be run but may indicate an error
Résultat void

BeginCreateReference() public méthode

Invoke the action asynchronously
Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndCreateReference().
public BeginCreateReference ( String aContainerID, String aObjectID, CallbackAsyncComplete aCallback ) : void
aContainerID String
aObjectID String
aCallback CallbackAsyncComplete Delegate to run when the action completes. /// This is guaranteed to be run but may indicate an error
Résultat void

BeginDestroyObject() public méthode

Invoke the action asynchronously
Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndDestroyObject().
public BeginDestroyObject ( String aObjectID, CallbackAsyncComplete aCallback ) : void
aObjectID String
aCallback CallbackAsyncComplete Delegate to run when the action completes. /// This is guaranteed to be run but may indicate an error
Résultat void

BeginGetIndexerStatus() public méthode

Invoke the action asynchronously
Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndGetIndexerStatus().
public BeginGetIndexerStatus ( CallbackAsyncComplete aCallback ) : void
aCallback CallbackAsyncComplete Delegate to run when the action completes. /// This is guaranteed to be run but may indicate an error
Résultat void

BeginGetSearchCapabilities() public méthode

Invoke the action asynchronously
Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndGetSearchCapabilities().
public BeginGetSearchCapabilities ( CallbackAsyncComplete aCallback ) : void
aCallback CallbackAsyncComplete Delegate to run when the action completes. /// This is guaranteed to be run but may indicate an error
Résultat void

BeginGetSortCapabilities() public méthode

Invoke the action asynchronously
Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndGetSortCapabilities().
public BeginGetSortCapabilities ( CallbackAsyncComplete aCallback ) : void
aCallback CallbackAsyncComplete Delegate to run when the action completes. /// This is guaranteed to be run but may indicate an error
Résultat void

BeginGetSourceInfo() public méthode

Invoke the action asynchronously
Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndGetSourceInfo().
public BeginGetSourceInfo ( String aSourceID, CallbackAsyncComplete aCallback ) : void
aSourceID String
aCallback CallbackAsyncComplete Delegate to run when the action completes. /// This is guaranteed to be run but may indicate an error
Résultat void

BeginGetSystemUpdateID() public méthode

Invoke the action asynchronously
Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndGetSystemUpdateID().
public BeginGetSystemUpdateID ( CallbackAsyncComplete aCallback ) : void
aCallback CallbackAsyncComplete Delegate to run when the action completes. /// This is guaranteed to be run but may indicate an error
Résultat void

BeginMoveInQueue() public méthode

Invoke the action asynchronously
Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndMoveInQueue().
public BeginMoveInQueue ( String aObjectID, uint aNewPosition, CallbackAsyncComplete aCallback ) : void
aObjectID String
aNewPosition uint
aCallback CallbackAsyncComplete Delegate to run when the action completes. /// This is guaranteed to be run but may indicate an error
Résultat void

BeginQueryDatabaseState() public méthode

Invoke the action asynchronously
Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndQueryDatabaseState().
public BeginQueryDatabaseState ( CallbackAsyncComplete aCallback ) : void
aCallback CallbackAsyncComplete Delegate to run when the action completes. /// This is guaranteed to be run but may indicate an error
Résultat void

BeginRemoveFromQueue() public méthode

Invoke the action asynchronously
Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndRemoveFromQueue().
public BeginRemoveFromQueue ( String aQueueID, uint aFromPosition, uint aToPosition, CallbackAsyncComplete aCallback ) : void
aQueueID String
aFromPosition uint
aToPosition uint
aCallback CallbackAsyncComplete Delegate to run when the action completes. /// This is guaranteed to be run but may indicate an error
Résultat void

BeginRenameQueue() public méthode

Invoke the action asynchronously
Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndRenameQueue().
public BeginRenameQueue ( String aQueueID, String aDesiredName, CallbackAsyncComplete aCallback ) : void
aQueueID String
aDesiredName String
aCallback CallbackAsyncComplete Delegate to run when the action completes. /// This is guaranteed to be run but may indicate an error
Résultat void

BeginRescanSource() public méthode

Invoke the action asynchronously
Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndRescanSource().
public BeginRescanSource ( String aSourceID, String aRescanMode, CallbackAsyncComplete aCallback ) : void
aSourceID String
aRescanMode String
aCallback CallbackAsyncComplete Delegate to run when the action completes. /// This is guaranteed to be run but may indicate an error
Résultat void

BeginResetDatabase() public méthode

Invoke the action asynchronously
Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndResetDatabase().
public BeginResetDatabase ( String aScope, CallbackAsyncComplete aCallback ) : void
aScope String
aCallback CallbackAsyncComplete Delegate to run when the action completes. /// This is guaranteed to be run but may indicate an error
Résultat void

BeginSearch() public méthode

Invoke the action asynchronously
Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndSearch().
public BeginSearch ( String aContainerID, String aSearchCriteria, String aFilter, uint aStartingIndex, uint aRequestedCount, String aSortCriteria, CallbackAsyncComplete aCallback ) : void
aContainerID String
aSearchCriteria String
aFilter String
aStartingIndex uint
aRequestedCount uint
aSortCriteria String
aCallback CallbackAsyncComplete Delegate to run when the action completes. /// This is guaranteed to be run but may indicate an error
Résultat void

BeginShuffle() public méthode

Invoke the action asynchronously
Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndShuffle().
public BeginShuffle ( String aContainerID, String aSelection, CallbackAsyncComplete aCallback ) : void
aContainerID String
aSelection String
aCallback CallbackAsyncComplete Delegate to run when the action completes. /// This is guaranteed to be run but may indicate an error
Résultat void

CpProxyUpnpOrgContentDirectory1() public méthode

Constructor
Use CpProxy::[Un]Subscribe() to enable/disable querying of state variable and reporting of their changes.
public CpProxyUpnpOrgContentDirectory1 ( CpDevice aDevice ) : System
aDevice OpenHome.Net.ControlPoint.CpDevice The device to use
Résultat System

Dispose() public méthode

Must be called for each class instance. Must be called before Core.Library.Close().
public Dispose ( ) : void
Résultat void

EndAddContainerToQueue() public méthode

Retrieve the output arguments from an asynchronously invoked action.
This may only be called from the callback set in the above Begin function.
public EndAddContainerToQueue ( IntPtr aAsyncHandle ) : void
aAsyncHandle System.IntPtr Argument passed to the delegate set in the above Begin function
Résultat void

EndAddItemToQueue() public méthode

Retrieve the output arguments from an asynchronously invoked action.
This may only be called from the callback set in the above Begin function.
public EndAddItemToQueue ( IntPtr aAsyncHandle ) : void
aAsyncHandle System.IntPtr Argument passed to the delegate set in the above Begin function
Résultat void

EndBrowse() public méthode

Retrieve the output arguments from an asynchronously invoked action.
This may only be called from the callback set in the above Begin function.
public EndBrowse ( IntPtr aAsyncHandle, String &aResult, uint &aNumberReturned, uint &aTotalMatches, uint &aUpdateID ) : void
aAsyncHandle System.IntPtr Argument passed to the delegate set in the above Begin function
aResult String
aNumberReturned uint
aTotalMatches uint
aUpdateID uint
Résultat void

EndCreateQueue() public méthode

Retrieve the output arguments from an asynchronously invoked action.
This may only be called from the callback set in the above Begin function.
public EndCreateQueue ( IntPtr aAsyncHandle, String &aGivenName, String &aQueueID, String &aMetaData ) : void
aAsyncHandle System.IntPtr Argument passed to the delegate set in the above Begin function
aGivenName String
aQueueID String
aMetaData String
Résultat void

EndCreateReference() public méthode

Retrieve the output arguments from an asynchronously invoked action.
This may only be called from the callback set in the above Begin function.
public EndCreateReference ( IntPtr aAsyncHandle, String &aNewID ) : void
aAsyncHandle System.IntPtr Argument passed to the delegate set in the above Begin function
aNewID String
Résultat void

EndDestroyObject() public méthode

Retrieve the output arguments from an asynchronously invoked action.
This may only be called from the callback set in the above Begin function.
public EndDestroyObject ( IntPtr aAsyncHandle ) : void
aAsyncHandle System.IntPtr Argument passed to the delegate set in the above Begin function
Résultat void

EndGetIndexerStatus() public méthode

Retrieve the output arguments from an asynchronously invoked action.
This may only be called from the callback set in the above Begin function.
public EndGetIndexerStatus ( IntPtr aAsyncHandle, String &aStatus ) : void
aAsyncHandle System.IntPtr Argument passed to the delegate set in the above Begin function
aStatus String
Résultat void

EndGetSearchCapabilities() public méthode

Retrieve the output arguments from an asynchronously invoked action.
This may only be called from the callback set in the above Begin function.
public EndGetSearchCapabilities ( IntPtr aAsyncHandle, String &aSearchCaps ) : void
aAsyncHandle System.IntPtr Argument passed to the delegate set in the above Begin function
aSearchCaps String
Résultat void

EndGetSortCapabilities() public méthode

Retrieve the output arguments from an asynchronously invoked action.
This may only be called from the callback set in the above Begin function.
public EndGetSortCapabilities ( IntPtr aAsyncHandle, String &aSortCaps ) : void
aAsyncHandle System.IntPtr Argument passed to the delegate set in the above Begin function
aSortCaps String
Résultat void

EndGetSourceInfo() public méthode

Retrieve the output arguments from an asynchronously invoked action.
This may only be called from the callback set in the above Begin function.
public EndGetSourceInfo ( IntPtr aAsyncHandle, uint &aNumTracks, uint &aTotalSize, uint &aTotalDuration, uint &aScanProgress, String &aIndexerResult ) : void
aAsyncHandle System.IntPtr Argument passed to the delegate set in the above Begin function
aNumTracks uint
aTotalSize uint
aTotalDuration uint
aScanProgress uint
aIndexerResult String
Résultat void

EndGetSystemUpdateID() public méthode

Retrieve the output arguments from an asynchronously invoked action.
This may only be called from the callback set in the above Begin function.
public EndGetSystemUpdateID ( IntPtr aAsyncHandle, uint &aId ) : void
aAsyncHandle System.IntPtr Argument passed to the delegate set in the above Begin function
aId uint
Résultat void

EndMoveInQueue() public méthode

Retrieve the output arguments from an asynchronously invoked action.
This may only be called from the callback set in the above Begin function.
public EndMoveInQueue ( IntPtr aAsyncHandle, uint &aContainerUpdateID ) : void
aAsyncHandle System.IntPtr Argument passed to the delegate set in the above Begin function
aContainerUpdateID uint
Résultat void

EndQueryDatabaseState() public méthode

Retrieve the output arguments from an asynchronously invoked action.
This may only be called from the callback set in the above Begin function.
public EndQueryDatabaseState ( IntPtr aAsyncHandle, uint &aCurrentNumResources, uint &aCriticalNumResources, uint &aCurrentDiskUsage, uint &aMaxDiskUsage ) : void
aAsyncHandle System.IntPtr Argument passed to the delegate set in the above Begin function
aCurrentNumResources uint
aCriticalNumResources uint
aCurrentDiskUsage uint
aMaxDiskUsage uint
Résultat void

EndRemoveFromQueue() public méthode

Retrieve the output arguments from an asynchronously invoked action.
This may only be called from the callback set in the above Begin function.
public EndRemoveFromQueue ( IntPtr aAsyncHandle, uint &aContainerUpdateID ) : void
aAsyncHandle System.IntPtr Argument passed to the delegate set in the above Begin function
aContainerUpdateID uint
Résultat void

EndRenameQueue() public méthode

Retrieve the output arguments from an asynchronously invoked action.
This may only be called from the callback set in the above Begin function.
public EndRenameQueue ( IntPtr aAsyncHandle, String &aGivenName ) : void
aAsyncHandle System.IntPtr Argument passed to the delegate set in the above Begin function
aGivenName String
Résultat void

EndRescanSource() public méthode

Retrieve the output arguments from an asynchronously invoked action.
This may only be called from the callback set in the above Begin function.
public EndRescanSource ( IntPtr aAsyncHandle ) : void
aAsyncHandle System.IntPtr Argument passed to the delegate set in the above Begin function
Résultat void

EndResetDatabase() public méthode

Retrieve the output arguments from an asynchronously invoked action.
This may only be called from the callback set in the above Begin function.
public EndResetDatabase ( IntPtr aAsyncHandle ) : void
aAsyncHandle System.IntPtr Argument passed to the delegate set in the above Begin function
Résultat void

EndSearch() public méthode

Retrieve the output arguments from an asynchronously invoked action.
This may only be called from the callback set in the above Begin function.
public EndSearch ( IntPtr aAsyncHandle, String &aResult, uint &aNumberReturned, uint &aTotalMatches, uint &aUpdateID ) : void
aAsyncHandle System.IntPtr Argument passed to the delegate set in the above Begin function
aResult String
aNumberReturned uint
aTotalMatches uint
aUpdateID uint
Résultat void

EndShuffle() public méthode

Retrieve the output arguments from an asynchronously invoked action.
This may only be called from the callback set in the above Begin function.
public EndShuffle ( IntPtr aAsyncHandle, String &aPlaylistID, String &aPlaylistMetadata ) : void
aAsyncHandle System.IntPtr Argument passed to the delegate set in the above Begin function
aPlaylistID String
aPlaylistMetadata String
Résultat void

PropertyA_ARG_TYPE_Scope() public méthode

Query the value of the A_ARG_TYPE_Scope property.
This function is threadsafe and can only be called if Subscribe() has been called and a first eventing callback received more recently than any call to Unsubscribe().
public PropertyA_ARG_TYPE_Scope ( ) : String
Résultat String

PropertyContainerUpdateIDs() public méthode

Query the value of the ContainerUpdateIDs property.
This function is threadsafe and can only be called if Subscribe() has been called and a first eventing callback received more recently than any call to Unsubscribe().
public PropertyContainerUpdateIDs ( ) : String
Résultat String

PropertyIndexerStatus() public méthode

Query the value of the IndexerStatus property.
This function is threadsafe and can only be called if Subscribe() has been called and a first eventing callback received more recently than any call to Unsubscribe().
public PropertyIndexerStatus ( ) : String
Résultat String

PropertySystemUpdateID() public méthode

Query the value of the SystemUpdateID property.
This function is threadsafe and can only be called if Subscribe() has been called and a first eventing callback received more recently than any call to Unsubscribe().
public PropertySystemUpdateID ( ) : uint
Résultat uint

SetPropertyA_ARG_TYPE_ScopeChanged() public méthode

Set a delegate to be run when the A_ARG_TYPE_Scope state variable changes.
Callbacks may be run in different threads but callbacks for a CpProxyUpnpOrgContentDirectory1 instance will not overlap.
public SetPropertyA_ARG_TYPE_ScopeChanged ( System aA_ARG_TYPE_ScopeChanged ) : void
aA_ARG_TYPE_ScopeChanged System The delegate to run when the state variable changes
Résultat void

SetPropertyContainerUpdateIDsChanged() public méthode

Set a delegate to be run when the ContainerUpdateIDs state variable changes.
Callbacks may be run in different threads but callbacks for a CpProxyUpnpOrgContentDirectory1 instance will not overlap.
public SetPropertyContainerUpdateIDsChanged ( System aContainerUpdateIDsChanged ) : void
aContainerUpdateIDsChanged System The delegate to run when the state variable changes
Résultat void

SetPropertyIndexerStatusChanged() public méthode

Set a delegate to be run when the IndexerStatus state variable changes.
Callbacks may be run in different threads but callbacks for a CpProxyUpnpOrgContentDirectory1 instance will not overlap.
public SetPropertyIndexerStatusChanged ( System aIndexerStatusChanged ) : void
aIndexerStatusChanged System The delegate to run when the state variable changes
Résultat void

SetPropertySystemUpdateIDChanged() public méthode

Set a delegate to be run when the SystemUpdateID state variable changes.
Callbacks may be run in different threads but callbacks for a CpProxyUpnpOrgContentDirectory1 instance will not overlap.
public SetPropertySystemUpdateIDChanged ( System aSystemUpdateIDChanged ) : void
aSystemUpdateIDChanged System The delegate to run when the state variable changes
Résultat void

SyncAddContainerToQueue() public méthode

Invoke the action synchronously
Blocks until the action has been processed on the device and sets any output arguments
public SyncAddContainerToQueue ( String aQueueID, String aContainerID, String aSourceID, String aSearchCriteria, String aSortCriteria, uint aStartIndex, uint aEndIndex, uint aPosition ) : void
aQueueID String
aContainerID String
aSourceID String
aSearchCriteria String
aSortCriteria String
aStartIndex uint
aEndIndex uint
aPosition uint
Résultat void

SyncAddItemToQueue() public méthode

Invoke the action synchronously
Blocks until the action has been processed on the device and sets any output arguments
public SyncAddItemToQueue ( String aQueueID, String aObjectID, uint aPosition ) : void
aQueueID String
aObjectID String
aPosition uint
Résultat void

SyncBrowse() public méthode

Invoke the action synchronously
Blocks until the action has been processed on the device and sets any output arguments
public SyncBrowse ( String aObjectID, String aBrowseFlag, String aFilter, uint aStartingIndex, uint aRequestedCount, String aSortCriteria, String &aResult, uint &aNumberReturned, uint &aTotalMatches, uint &aUpdateID ) : void
aObjectID String
aBrowseFlag String
aFilter String
aStartingIndex uint
aRequestedCount uint
aSortCriteria String
aResult String
aNumberReturned uint
aTotalMatches uint
aUpdateID uint
Résultat void

SyncCreateQueue() public méthode

Invoke the action synchronously
Blocks until the action has been processed on the device and sets any output arguments
public SyncCreateQueue ( String aDesiredName, String aContainerID, String &aGivenName, String &aQueueID, String &aMetaData ) : void
aDesiredName String
aContainerID String
aGivenName String
aQueueID String
aMetaData String
Résultat void

SyncCreateReference() public méthode

Invoke the action synchronously
Blocks until the action has been processed on the device and sets any output arguments
public SyncCreateReference ( String aContainerID, String aObjectID, String &aNewID ) : void
aContainerID String
aObjectID String
aNewID String
Résultat void

SyncDestroyObject() public méthode

Invoke the action synchronously
Blocks until the action has been processed on the device and sets any output arguments
public SyncDestroyObject ( String aObjectID ) : void
aObjectID String
Résultat void

SyncGetIndexerStatus() public méthode

Invoke the action synchronously
Blocks until the action has been processed on the device and sets any output arguments
public SyncGetIndexerStatus ( String &aStatus ) : void
aStatus String
Résultat void

SyncGetSearchCapabilities() public méthode

Invoke the action synchronously
Blocks until the action has been processed on the device and sets any output arguments
public SyncGetSearchCapabilities ( String &aSearchCaps ) : void
aSearchCaps String
Résultat void

SyncGetSortCapabilities() public méthode

Invoke the action synchronously
Blocks until the action has been processed on the device and sets any output arguments
public SyncGetSortCapabilities ( String &aSortCaps ) : void
aSortCaps String
Résultat void

SyncGetSourceInfo() public méthode

Invoke the action synchronously
Blocks until the action has been processed on the device and sets any output arguments
public SyncGetSourceInfo ( String aSourceID, uint &aNumTracks, uint &aTotalSize, uint &aTotalDuration, uint &aScanProgress, String &aIndexerResult ) : void
aSourceID String
aNumTracks uint
aTotalSize uint
aTotalDuration uint
aScanProgress uint
aIndexerResult String
Résultat void

SyncGetSystemUpdateID() public méthode

Invoke the action synchronously
Blocks until the action has been processed on the device and sets any output arguments
public SyncGetSystemUpdateID ( uint &aId ) : void
aId uint
Résultat void

SyncMoveInQueue() public méthode

Invoke the action synchronously
Blocks until the action has been processed on the device and sets any output arguments
public SyncMoveInQueue ( String aObjectID, uint aNewPosition, uint &aContainerUpdateID ) : void
aObjectID String
aNewPosition uint
aContainerUpdateID uint
Résultat void

SyncQueryDatabaseState() public méthode

Invoke the action synchronously
Blocks until the action has been processed on the device and sets any output arguments
public SyncQueryDatabaseState ( uint &aCurrentNumResources, uint &aCriticalNumResources, uint &aCurrentDiskUsage, uint &aMaxDiskUsage ) : void
aCurrentNumResources uint
aCriticalNumResources uint
aCurrentDiskUsage uint
aMaxDiskUsage uint
Résultat void

SyncRemoveFromQueue() public méthode

Invoke the action synchronously
Blocks until the action has been processed on the device and sets any output arguments
public SyncRemoveFromQueue ( String aQueueID, uint aFromPosition, uint aToPosition, uint &aContainerUpdateID ) : void
aQueueID String
aFromPosition uint
aToPosition uint
aContainerUpdateID uint
Résultat void

SyncRenameQueue() public méthode

Invoke the action synchronously
Blocks until the action has been processed on the device and sets any output arguments
public SyncRenameQueue ( String aQueueID, String aDesiredName, String &aGivenName ) : void
aQueueID String
aDesiredName String
aGivenName String
Résultat void

SyncRescanSource() public méthode

Invoke the action synchronously
Blocks until the action has been processed on the device and sets any output arguments
public SyncRescanSource ( String aSourceID, String aRescanMode ) : void
aSourceID String
aRescanMode String
Résultat void

SyncResetDatabase() public méthode

Invoke the action synchronously
Blocks until the action has been processed on the device and sets any output arguments
public SyncResetDatabase ( String aScope ) : void
aScope String
Résultat void

SyncSearch() public méthode

Invoke the action synchronously
Blocks until the action has been processed on the device and sets any output arguments
public SyncSearch ( String aContainerID, String aSearchCriteria, String aFilter, uint aStartingIndex, uint aRequestedCount, String aSortCriteria, String &aResult, uint &aNumberReturned, uint &aTotalMatches, uint &aUpdateID ) : void
aContainerID String
aSearchCriteria String
aFilter String
aStartingIndex uint
aRequestedCount uint
aSortCriteria String
aResult String
aNumberReturned uint
aTotalMatches uint
aUpdateID uint
Résultat void

SyncShuffle() public méthode

Invoke the action synchronously
Blocks until the action has been processed on the device and sets any output arguments
public SyncShuffle ( String aContainerID, String aSelection, String &aPlaylistID, String &aPlaylistMetadata ) : void
aContainerID String
aSelection String
aPlaylistID String
aPlaylistMetadata String
Résultat void