AudioFeed Interface

Audio stream (PlayList) object interface

Definition

Namespace: TCX.Configuration
Assembly: 3cxpscomcpp2 (in 3cxpscomcpp2.dll) Version: 20.0.1
C#
public interface AudioFeed : IOMStorable, 
	IOMRemovable, IOMSnapshot, IEquatable<Object>, IDisposable
Implements
IDisposable, IEquatableObject, IOMRemovable, IOMSnapshot, IOMStorable

Properties

AutoGain control over quiet audio.
if set to true - audio provider will adjust volume dynamically. If MaxVolume is set to 0 value of this property is ignored and global settings are used.
HasAttached Indicates that the object has attached data for saving transaction
(Inherited from IOMSnapshot)
ID each object has unique ID. It is the same as the value returned by GetHashCode. (legacy) new object has ID=0. After successful call to save snapshot gets persistent ID.
(Inherited from IOMSnapshot)
MaxAnnouncementPause maximal interval (in seconds) between announcements
MaxVolume sets the peak volume of the stream
values - 0-100
0 - not specified for this stream (global volume settings is used)
100 - 0dB no limit
70 not more then ~ -3dB
50 not more then ~ -6dB
35 not more then ~ -9dB
25 not more then ~ -12dB
16 not more then ~ -16db
12 not more then ~ -18dB
10 not more then ~ -20dB
for play list: each file is normalized separatelly.
linein: if audio volume is varying in wide range then AutoGain=true is recommended.
MinAnnouncementPause minimal interval (in seconds) between announcements
Name name of the stream. Must be lowcase ASCII
NoPauseIfEmpty if set to true - stream will advance in the background. if set to false - stream will be paused if nobody needs it.
PlayAnnouncements play random Announcement in foreground.
Source source of the stream
Type type of the source AudioFeedType and Source

Methods

AttachOnSave(IEnumerableIOMSnapshot) This method allows to add other object updates to the main object saving transaction
(Inherited from IOMSnapshot)
AttachOnSave(IOMSnapshot) This method allows to add other object updates to the saving transaction of main object
(Inherited from IOMSnapshot)
Clone Makes fresh snapshot of the object without modifications
(Inherited from IOMSnapshot)
Delete Delete object from configuration database.
(Inherited from IOMRemovable)
DeleteOnSave(IEnumerableIOMSnapshot) Allows to remove other objects as a part of the main object saving transaction.
(Inherited from IOMSnapshot)
DeleteOnSave(IOMSnapshot) Allows to remove other objects as a part of the main object saving transaction.
(Inherited from IOMSnapshot)
GetHashCode Hash code is "record" identifier. So all snapshots of the object has the same hash.
(Inherited from IOMSnapshot)
Refresh Reverts all modifications (if any) and reloads object from configuration/realtime storage
(Inherited from IOMStorable)
Save Commits the changes. This method inserts new or update existing object in persistent storage.
(Inherited from IOMStorable)
ToString Brief description of object in term of Object model. default implementation is ToString. Concrete implementation may be more verbose.
(Inherited from IOMSnapshot)

Extension Methods

Deserialize deserializes object and remenber repeatlist. object can be saved
(Defined by SerializationExtension)
GetSerializableProperties Returns list of properties which are require serialization
(Defined by SerializationExtension)
OMDelete Apply update of the specific snapshot. virtually any object may be updated even those which are not supporting IOMStorable interface.
(Defined by CollectionTransactionsHelper)
OMSave Apply update of the specific snapshot. virtually any object may be updated even those which are not supporting IOMStorable interface.
(Defined by CollectionTransactionsHelper)
SerializeObject Deserializer for IOMSnapshot
(Defined by SerializationExtension)
SerializeProperty returns false if there are no enough information at the moment and it should be repeated after after all objects will be restored. Typical case is forward reference to the DN object.
(Defined by SerializationExtension)
TryDeserializeProperty returns false if there are no enough information at the moment and it should be repeated after after all objects will be restored. Typical case is forward reference to the DN object.
(Defined by SerializationExtension)

See Also