C# Class OpenHome.Net.Device.Providers.DvProviderAvOpenhomeOrgSender1

Provider for the av.openhome.org:Sender:1 UPnP service

Inheritance: DvProvider, IDisposable, IDvProviderAvOpenhomeOrgSender1

ファイルを表示 Open project: openhome/ohNet Class Usage Examples

Public Methods

Method	Description
Dispose ( ) : void	Must be called for each class instance. Must be called before Core.Library.Close().
EnablePropertyAttributes ( ) : void	Enable the Attributes property.
EnablePropertyAudio ( ) : void	Enable the Audio property.
EnablePropertyMetadata ( ) : void	Enable the Metadata property.
EnablePropertyPresentationUrl ( ) : void	Enable the PresentationUrl property.
EnablePropertyStatus ( ) : void	Enable the Status property.
PropertyAttributes ( ) : string	Get a copy of the value of the Attributes property Can only be called if EnablePropertyAttributes has previously been called.
PropertyAudio ( ) : bool	Get a copy of the value of the Audio property Can only be called if EnablePropertyAudio has previously been called.
PropertyMetadata ( ) : string	Get a copy of the value of the Metadata property Can only be called if EnablePropertyMetadata has previously been called.
PropertyPresentationUrl ( ) : string	Get a copy of the value of the PresentationUrl property Can only be called if EnablePropertyPresentationUrl has previously been called.
PropertyStatus ( ) : string	Get a copy of the value of the Status property Can only be called if EnablePropertyStatus has previously been called.
SetPropertyAttributes ( string aValue ) : bool	Set the value of the Attributes property Can only be called if EnablePropertyAttributes has previously been called.
SetPropertyAudio ( bool aValue ) : bool	Set the value of the Audio property Can only be called if EnablePropertyAudio has previously been called.
SetPropertyMetadata ( string aValue ) : bool	Set the value of the Metadata property Can only be called if EnablePropertyMetadata has previously been called.
SetPropertyPresentationUrl ( string aValue ) : bool	Set the value of the PresentationUrl property Can only be called if EnablePropertyPresentationUrl has previously been called.
SetPropertyStatus ( string aValue ) : bool	Set the value of the Status property Can only be called if EnablePropertyStatus has previously been called.

Protected Methods

Method	Description
Attributes ( IDvInvocation aInvocation, string &aValue ) : void	Attributes action. Will be called when the device stack receives an invocation of the Attributes action for the owning device. Must be implemented iff EnableActionAttributes was called.
Audio ( IDvInvocation aInvocation, bool &aValue ) : void	Audio action. Will be called when the device stack receives an invocation of the Audio action for the owning device. Must be implemented iff EnableActionAudio was called.
DvProviderAvOpenhomeOrgSender1 ( DvDevice aDevice ) : System	Constructor
EnableActionAttributes ( ) : void	Signal that the action Attributes is supported. The action's availability will be published in the device's service.xml. Attributes must be overridden if this is called.
EnableActionAudio ( ) : void	Signal that the action Audio is supported. The action's availability will be published in the device's service.xml. Audio must be overridden if this is called.
EnableActionMetadata ( ) : void	Signal that the action Metadata is supported. The action's availability will be published in the device's service.xml. Metadata must be overridden if this is called.
EnableActionPresentationUrl ( ) : void	Signal that the action PresentationUrl is supported. The action's availability will be published in the device's service.xml. PresentationUrl must be overridden if this is called.
EnableActionStatus ( ) : void	Signal that the action Status is supported. The action's availability will be published in the device's service.xml. Status must be overridden if this is called.
Metadata ( IDvInvocation aInvocation, string &aValue ) : void	Metadata action. Will be called when the device stack receives an invocation of the Metadata action for the owning device. Must be implemented iff EnableActionMetadata was called.
PresentationUrl ( IDvInvocation aInvocation, string &aValue ) : void	PresentationUrl action. Will be called when the device stack receives an invocation of the PresentationUrl action for the owning device. Must be implemented iff EnableActionPresentationUrl was called.
Status ( IDvInvocation aInvocation, string &aValue ) : void	Status action. Will be called when the device stack receives an invocation of the Status action for the owning device. Must be implemented iff EnableActionStatus was called.

Private Methods

Method	Description
DoAttributes ( IntPtr aPtr, IntPtr aInvocation ) : int
DoAudio ( IntPtr aPtr, IntPtr aInvocation ) : int
DoMetadata ( IntPtr aPtr, IntPtr aInvocation ) : int
DoPresentationUrl ( IntPtr aPtr, IntPtr aInvocation ) : int
DoStatus ( IntPtr aPtr, IntPtr aInvocation ) : int

Method Details

Attributes() protected method

Attributes action.

Will be called when the device stack receives an invocation of the Attributes action for the owning device. Must be implemented iff EnableActionAttributes was called.

protected Attributes ( IDvInvocation aInvocation, string &aValue ) : void
aInvocation	IDvInvocation	Interface allowing querying of aspects of this particular action invocation.
aValue	string
return	void

Audio() protected method

Audio action.

Will be called when the device stack receives an invocation of the Audio action for the owning device. Must be implemented iff EnableActionAudio was called.

protected Audio ( IDvInvocation aInvocation, bool &aValue ) : void
aInvocation	IDvInvocation	Interface allowing querying of aspects of this particular action invocation.
aValue	bool
return	void

Dispose() public method

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

public Dispose ( ) : void
return	void

DvProviderAvOpenhomeOrgSender1() protected method

Constructor

protected DvProviderAvOpenhomeOrgSender1 ( DvDevice aDevice ) : System
aDevice	DvDevice	Device which owns this provider
return	System

EnableActionAttributes() protected method

Signal that the action Attributes is supported.

The action's availability will be published in the device's service.xml. Attributes must be overridden if this is called.

protected EnableActionAttributes ( ) : void
return	void

EnableActionAudio() protected method

Signal that the action Audio is supported.

The action's availability will be published in the device's service.xml. Audio must be overridden if this is called.

protected EnableActionAudio ( ) : void
return	void

EnableActionMetadata() protected method

Signal that the action Metadata is supported.

The action's availability will be published in the device's service.xml. Metadata must be overridden if this is called.

protected EnableActionMetadata ( ) : void
return	void

EnableActionPresentationUrl() protected method

Signal that the action PresentationUrl is supported.

The action's availability will be published in the device's service.xml. PresentationUrl must be overridden if this is called.

protected EnableActionPresentationUrl ( ) : void
return	void

EnableActionStatus() protected method

Signal that the action Status is supported.

The action's availability will be published in the device's service.xml. Status must be overridden if this is called.

protected EnableActionStatus ( ) : void
return	void

EnablePropertyAttributes() public method

Enable the Attributes property.

public EnablePropertyAttributes ( ) : void
return	void

EnablePropertyAudio() public method

Enable the Audio property.

public EnablePropertyAudio ( ) : void
return	void

EnablePropertyMetadata() public method

Enable the Metadata property.

public EnablePropertyMetadata ( ) : void
return	void

EnablePropertyPresentationUrl() public method

Enable the PresentationUrl property.

public EnablePropertyPresentationUrl ( ) : void
return	void

EnablePropertyStatus() public method

Enable the Status property.

public EnablePropertyStatus ( ) : void
return	void

Metadata() protected method

Metadata action.

Will be called when the device stack receives an invocation of the Metadata action for the owning device. Must be implemented iff EnableActionMetadata was called.

protected Metadata ( IDvInvocation aInvocation, string &aValue ) : void
aInvocation	IDvInvocation	Interface allowing querying of aspects of this particular action invocation.
aValue	string
return	void

PresentationUrl() protected method

PresentationUrl action.

Will be called when the device stack receives an invocation of the PresentationUrl action for the owning device. Must be implemented iff EnableActionPresentationUrl was called.

protected PresentationUrl ( IDvInvocation aInvocation, string &aValue ) : void
aInvocation	IDvInvocation	Interface allowing querying of aspects of this particular action invocation.
aValue	string
return	void

PropertyAttributes() public method

Get a copy of the value of the Attributes property

Can only be called if EnablePropertyAttributes has previously been called.

public PropertyAttributes ( ) : string
return	string

PropertyAudio() public method

Get a copy of the value of the Audio property

Can only be called if EnablePropertyAudio has previously been called.

public PropertyAudio ( ) : bool
return	bool

PropertyMetadata() public method

Get a copy of the value of the Metadata property

Can only be called if EnablePropertyMetadata has previously been called.

public PropertyMetadata ( ) : string
return	string

PropertyPresentationUrl() public method

Get a copy of the value of the PresentationUrl property

Can only be called if EnablePropertyPresentationUrl has previously been called.

public PropertyPresentationUrl ( ) : string
return	string

PropertyStatus() public method

Get a copy of the value of the Status property

Can only be called if EnablePropertyStatus has previously been called.

public PropertyStatus ( ) : string
return	string

SetPropertyAttributes() public method

Set the value of the Attributes property

Can only be called if EnablePropertyAttributes has previously been called.

public SetPropertyAttributes ( string aValue ) : bool
aValue	string	New value for the property
return	bool

SetPropertyAudio() public method

Set the value of the Audio property

Can only be called if EnablePropertyAudio has previously been called.

public SetPropertyAudio ( bool aValue ) : bool
aValue	bool	New value for the property
return	bool

SetPropertyMetadata() public method

Set the value of the Metadata property

Can only be called if EnablePropertyMetadata has previously been called.

public SetPropertyMetadata ( string aValue ) : bool
aValue	string	New value for the property
return	bool

SetPropertyPresentationUrl() public method

Set the value of the PresentationUrl property

Can only be called if EnablePropertyPresentationUrl has previously been called.

public SetPropertyPresentationUrl ( string aValue ) : bool
aValue	string	New value for the property
return	bool

SetPropertyStatus() public method

Set the value of the Status property

Can only be called if EnablePropertyStatus has previously been called.

public SetPropertyStatus ( string aValue ) : bool
aValue	string	New value for the property
return	bool

Status() protected method

Status action.

Will be called when the device stack receives an invocation of the Status action for the owning device. Must be implemented iff EnableActionStatus was called.

protected Status ( IDvInvocation aInvocation, string &aValue ) : void
aInvocation	IDvInvocation	Interface allowing querying of aspects of this particular action invocation.
aValue	string
return	void