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

Proxy for the av.openhome.org:Sender:1 UPnP service
Inheritance: OpenHome.Net.ControlPoint.CpProxy, IDisposable, ICpProxyAvOpenhomeOrgSender1
Mostrar archivo Open project: openhome/ohNet Class Usage Examples

Public Methods

Method Description
BeginAttributes ( 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 EndAttributes().

BeginAudio ( 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 EndAudio().

BeginMetadata ( 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 EndMetadata().

BeginPresentationUrl ( 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 EndPresentationUrl().

BeginStatus ( 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 EndStatus().

CpProxyAvOpenhomeOrgSender1 ( ICpDevice 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().

EndAttributes ( IntPtr aAsyncHandle, String &aValue ) : void

Retrieve the output arguments from an asynchronously invoked action.

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

EndAudio ( IntPtr aAsyncHandle, bool &aValue ) : void

Retrieve the output arguments from an asynchronously invoked action.

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

EndMetadata ( IntPtr aAsyncHandle, String &aValue ) : void

Retrieve the output arguments from an asynchronously invoked action.

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

EndPresentationUrl ( IntPtr aAsyncHandle, String &aValue ) : void

Retrieve the output arguments from an asynchronously invoked action.

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

EndStatus ( IntPtr aAsyncHandle, String &aValue ) : void

Retrieve the output arguments from an asynchronously invoked action.

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

PropertyAttributes ( ) : String

Query the value of the Attributes 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().

PropertyAudio ( ) : bool

Query the value of the Audio 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().

PropertyMetadata ( ) : String

Query the value of the Metadata 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().

PropertyPresentationUrl ( ) : String

Query the value of the PresentationUrl 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().

PropertyStatus ( ) : String

Query the value of the Status 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().

SetPropertyAttributesChanged ( System aAttributesChanged ) : void

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

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

SetPropertyAudioChanged ( System aAudioChanged ) : void

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

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

SetPropertyMetadataChanged ( System aMetadataChanged ) : void

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

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

SetPropertyPresentationUrlChanged ( System aPresentationUrlChanged ) : void

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

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

SetPropertyStatusChanged ( System aStatusChanged ) : void

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

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

SyncAttributes ( String &aValue ) : void

Invoke the action synchronously

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

SyncAudio ( bool &aValue ) : void

Invoke the action synchronously

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

SyncMetadata ( String &aValue ) : void

Invoke the action synchronously

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

SyncPresentationUrl ( String &aValue ) : void

Invoke the action synchronously

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

SyncStatus ( String &aValue ) : void

Invoke the action synchronously

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

Private Methods

Method Description
AttributesPropertyChanged ( ) : void
AudioPropertyChanged ( ) : void
MetadataPropertyChanged ( ) : void
PresentationUrlPropertyChanged ( ) : void
StatusPropertyChanged ( ) : void

Method Details

BeginAttributes() public method

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 EndAttributes().
public BeginAttributes ( CallbackAsyncComplete aCallback ) : void
aCallback CallbackAsyncComplete Delegate to run when the action completes. /// This is guaranteed to be run but may indicate an error
return void

BeginAudio() public method

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 EndAudio().
public BeginAudio ( CallbackAsyncComplete aCallback ) : void
aCallback CallbackAsyncComplete Delegate to run when the action completes. /// This is guaranteed to be run but may indicate an error
return void

BeginMetadata() public method

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 EndMetadata().
public BeginMetadata ( CallbackAsyncComplete aCallback ) : void
aCallback CallbackAsyncComplete Delegate to run when the action completes. /// This is guaranteed to be run but may indicate an error
return void

BeginPresentationUrl() public method

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 EndPresentationUrl().
public BeginPresentationUrl ( CallbackAsyncComplete aCallback ) : void
aCallback CallbackAsyncComplete Delegate to run when the action completes. /// This is guaranteed to be run but may indicate an error
return void

BeginStatus() public method

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 EndStatus().
public BeginStatus ( CallbackAsyncComplete aCallback ) : void
aCallback CallbackAsyncComplete Delegate to run when the action completes. /// This is guaranteed to be run but may indicate an error
return void

CpProxyAvOpenhomeOrgSender1() public method

Constructor
Use CpProxy::[Un]Subscribe() to enable/disable querying of state variable and reporting of their changes.
public CpProxyAvOpenhomeOrgSender1 ( ICpDevice aDevice ) : System
aDevice ICpDevice The device to use
return System

Dispose() public method

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

EndAttributes() public method

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

EndAudio() public method

Retrieve the output arguments from an asynchronously invoked action.
This may only be called from the callback set in the above Begin function.
public EndAudio ( IntPtr aAsyncHandle, bool &aValue ) : void
aAsyncHandle System.IntPtr Argument passed to the delegate set in the above Begin function
aValue bool
return void

EndMetadata() public method

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

EndPresentationUrl() public method

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

EndStatus() public method

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

PropertyAttributes() public method

Query the value of the Attributes 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 PropertyAttributes ( ) : String
return String

PropertyAudio() public method

Query the value of the Audio 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 PropertyAudio ( ) : bool
return bool

PropertyMetadata() public method

Query the value of the Metadata 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 PropertyMetadata ( ) : String
return String

PropertyPresentationUrl() public method

Query the value of the PresentationUrl 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 PropertyPresentationUrl ( ) : String
return String

PropertyStatus() public method

Query the value of the Status 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 PropertyStatus ( ) : String
return String

SetPropertyAttributesChanged() public method

Set a delegate to be run when the Attributes state variable changes.
Callbacks may be run in different threads but callbacks for a CpProxyAvOpenhomeOrgSender1 instance will not overlap.
public SetPropertyAttributesChanged ( System aAttributesChanged ) : void
aAttributesChanged System The delegate to run when the state variable changes
return void

SetPropertyAudioChanged() public method

Set a delegate to be run when the Audio state variable changes.
Callbacks may be run in different threads but callbacks for a CpProxyAvOpenhomeOrgSender1 instance will not overlap.
public SetPropertyAudioChanged ( System aAudioChanged ) : void
aAudioChanged System The delegate to run when the state variable changes
return void

SetPropertyMetadataChanged() public method

Set a delegate to be run when the Metadata state variable changes.
Callbacks may be run in different threads but callbacks for a CpProxyAvOpenhomeOrgSender1 instance will not overlap.
public SetPropertyMetadataChanged ( System aMetadataChanged ) : void
aMetadataChanged System The delegate to run when the state variable changes
return void

SetPropertyPresentationUrlChanged() public method

Set a delegate to be run when the PresentationUrl state variable changes.
Callbacks may be run in different threads but callbacks for a CpProxyAvOpenhomeOrgSender1 instance will not overlap.
public SetPropertyPresentationUrlChanged ( System aPresentationUrlChanged ) : void
aPresentationUrlChanged System The delegate to run when the state variable changes
return void

SetPropertyStatusChanged() public method

Set a delegate to be run when the Status state variable changes.
Callbacks may be run in different threads but callbacks for a CpProxyAvOpenhomeOrgSender1 instance will not overlap.
public SetPropertyStatusChanged ( System aStatusChanged ) : void
aStatusChanged System The delegate to run when the state variable changes
return void

SyncAttributes() public method

Invoke the action synchronously
Blocks until the action has been processed on the device and sets any output arguments
public SyncAttributes ( String &aValue ) : void
aValue String
return void

SyncAudio() public method

Invoke the action synchronously
Blocks until the action has been processed on the device and sets any output arguments
public SyncAudio ( bool &aValue ) : void
aValue bool
return void

SyncMetadata() public method

Invoke the action synchronously
Blocks until the action has been processed on the device and sets any output arguments
public SyncMetadata ( String &aValue ) : void
aValue String
return void

SyncPresentationUrl() public method

Invoke the action synchronously
Blocks until the action has been processed on the device and sets any output arguments
public SyncPresentationUrl ( String &aValue ) : void
aValue String
return void

SyncStatus() public method

Invoke the action synchronously
Blocks until the action has been processed on the device and sets any output arguments
public SyncStatus ( String &aValue ) : void
aValue String
return void