Sound |
Ambient sound in the scene.
Inheritance HierarchyNamespace: NeoAxis
Assembly: NeoAxis.Core (in NeoAxis.Core.dll) Version: 2026.2.1.0 (2026.2.1.0)
SyntaxC#
public class SoundSource : ObjectInSpace
The SoundSource type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoundSource | Initializes a new instance of the SoundSource class |
Properties| Name | Description | |
|---|---|---|
 | AnyData |
The user data of the component.
(Inherited from Component) |
| AttenuationFar | The maximum distance from the listener, after which no sound is heard. |
| AttenuationNear | The minimum distance from the listener, after which the sound begins to weaken. |
| BaseType |
Gets the base type of the object.
(Inherited from Component) |
| CanBeSelected |
Whether the object is selectable in the scene view.
(Inherited from ObjectInSpace) |
| CanBeSelectedInHierarchy | (Inherited from ObjectInSpace) |
| Channel | |
| CloneSupport |
Whether the object supports cloning.
(Inherited from Component) |
| Components |
Gets the collection of the child components.
(Inherited from Component) |
| CreatedByBaseType |
Whether the object is created using a base type.
(Inherited from Component) |
| DisplayInEditor |
Whether to show the object in the editor.
(Inherited from Component) |
| Disposed |
Whether the object is disposed.
(Inherited from Component) |
| EditorDocumentConfiguration |
Gets or sets the configuration data of the object's settings in the editor.
(Inherited from Component) |
| EditorReadOnly |
Whether the object is read only in the editor.
(Inherited from Component) |
| EditorReadOnlyInHierarchy |
Whether the object is read-only in the editor with respect to parent objects.
(Inherited from Component) |
| Enabled |
Whether the component is enabled. Any functionality of component is not works when it disabled.
(Inherited from Component) |
| EnabledInHierarchy |
Determines whether the object is attached to a hierarchy of the components and enabled. The object will be enabled only when all parents are enabled, and the property Enabled is enabled.
(Inherited from Component) |
| EnabledInHierarchyAndIsInstance |
Determines when the object is attached to a hierarchy of the components, is enabled and the object if not part of a resource (it is usual object instance). The object will be enabled only when all parents are enabled, and the property Enabled is enabled.
(Inherited from Component) |
| EnabledSelectionByCursor | (Inherited from ObjectInSpace) |
| HierarchyController |
Gets the object hierarchy control controller.
(Inherited from Component) |
| IsResource | (Inherited from Component) |
| Mode3D | Whether to play in 3D mode. |
| Name |
The name of the component.
(Inherited from Component) |
| NetworkID | (Inherited from Component) |
| NetworkIsClient | (Inherited from Component) |
| NetworkIsServer |
Whether to work in network server mode. It is false until the scene is not loaded.
(Inherited from Component) |
| NetworkIsSingle | (Inherited from Component) |
| NetworkIsSingleOrClient | (Inherited from Component) |
| NetworkMode |
Whether to enable synchronization of the component between server and clients.
(Inherited from Component) |
| NetworkModeUsers | (Inherited from Component) |
| Parent |
Gets the parent object.
(Inherited from Component) |
| ParentRoot |
Gets the parent root object.
(Inherited from Component) |
| ParentScene |
Gets the parent scene object.
(Inherited from Component) |
| Pitch | The playback speed of sound. |
| Priority | This parameter allows you to set the priority when playing sounds. |
| RemainingLifetime |
The lifetime of the component during the simulation.
(Inherited from ObjectInSpace) |
| RemoveFromParentQueued |
Whether the object is placed in the detach queue from the parent.
(Inherited from Component) |
| ReplayDelay | The delay between the completion of playing sound and playing it again. |
| RolloffLogarithmicFactor | Damping factor for the logarithmic rolloff mode. |
| RolloffMode | Calculation type of the damping volume depending on the distance from the camera. |
| SaveSupport |
Whether the object supports saving to a file.
(Inherited from Component) |
| ScreenLabel |
The displaying mode of an on-screen label of the component in the scene editor.
(Inherited from Component) |
| Sound | Sound file to be played by the source. |
| SpaceBounds | (Inherited from ObjectInSpace) |
| SpaceBoundsOctreeOverride | (Inherited from ObjectInSpace) |
| SpaceBoundsOverride | (Inherited from ObjectInSpace) |
| Streaming | This parameter enables streaming reading from the file while playing. |
| Transform |
The position, rotation and scale of the object.
(Inherited from ObjectInSpace) |
| TransformInterpolation |
Whether to interpolate the transform between simulation steps.
(Inherited from ObjectInSpace) |
| TransformV |
Simplier form of Transform.Value.
(Inherited from ObjectInSpace) |
| TypeSettingsPrivateObjects |
Object settings when used as a type.
(Inherited from Component) |
| Visible |
Whether the object is visible in the scene.
(Inherited from ObjectInSpace) |
| VisibleInHierarchy | (Inherited from ObjectInSpace) |
| Volume | Sound volume. |
Methods| Name | Description | |
|---|---|---|
| AddComponent |
Adds a component as a child.
(Inherited from Component) |
| BeginNetworkMessage(ServerNetworkService_ComponentsClientItem, String) | (Inherited from Component) |
| BeginNetworkMessage(IListServerNetworkService_ComponentsClientItem, String) | (Inherited from Component) |
| BeginNetworkMessage(IListServerNetworkService_UsersUserInfo, String) | (Inherited from Component) |
| BeginNetworkMessage(ServerNetworkService_UsersUserInfo, String) | (Inherited from Component) |
| BeginNetworkMessageToEveryone | (Inherited from Component) |
| BeginNetworkMessageToServer | (Inherited from Component) |
| CheckSelectionByRay | (Inherited from ObjectInSpace) |
| Clone |
Creates a copy of the object.
(Inherited from Component) |
| CreateComponent(Type, Int32, Boolean, Boolean, NetworkModeEnum) |
Creates a child component.
(Inherited from Component) |
| CreateComponent(MetadataTypeInfo, Int32, Boolean, Boolean, NetworkModeEnum) |
Creates a child component.
(Inherited from Component) |
| CreateComponentT(Int32, Boolean, Boolean, NetworkModeEnum) |
Creates a child component.
(Inherited from Component) |
| DebugDraw | |
| Dispose |
Detaches the object from the hierarchy and deletes the object data.
(Inherited from Component) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| FindParent(Type) |
Finds the parent of the specified type.
(Inherited from Component) |
| FindParent(MetadataTypeInfo) |
Finds the parent of the specified type.
(Inherited from Component) |
| FindParentT |
Finds the parent of the specified type.
(Inherited from Component) |
| FindThisOrParent(Type) |
Finds the parent or self of the specified type.
(Inherited from Component) |
| FindThisOrParent(MetadataTypeInfo) |
Finds the parent or self of the specified type.
(Inherited from Component) |
| FindThisOrParentT |
Finds the parent or self of the specified type.
(Inherited from Component) |
| GetAllParents |
Gets all parents of the component.
(Inherited from Component) |
| GetComponent(String, Boolean) |
Finds a child component by name.
(Inherited from Component) |
| GetComponent(Type, Boolean, Boolean) |
Finds a child component of the specified type.
(Inherited from Component) |
| GetComponent(MetadataTypeInfo, Boolean, Boolean) |
Finds a child component of the specified type.
(Inherited from Component) |
| GetComponentT(Boolean, Boolean) |
Finds a child component of the specified type.
(Inherited from Component) |
| GetComponentByNameWithIndex |
Finds a child component by name and number in the case when there are several components with the specified name.
(Inherited from Component) |
| GetComponentByPath |
Finds a child component by path.
(Inherited from Component) |
| GetComponents(Boolean, Boolean, Boolean, Boolean) |
Finds child components.
(Inherited from Component) |
| GetComponents(Boolean, Boolean, Boolean, Boolean, ActionComponent) |
Finds child components.
(Inherited from Component) |
| GetComponents(Type, Boolean, Boolean, Boolean, Boolean) |
Finds child components of the specified type.
(Inherited from Component) |
| GetComponents(MetadataTypeInfo, Boolean, Boolean, Boolean, Boolean) |
Finds child components of the specified type.
(Inherited from Component) |
| GetComponentsT(Boolean, Boolean, Boolean, Boolean, ActionT) |
Finds child components of the specified type.
(Inherited from Component) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetPathFromParent |
Returns the path to the object from the parent.
(Inherited from Component) |
| GetPathFromRoot |
Returns the object's access path from the root object.
(Inherited from Component) |
| GetProvidedType |
Returns a type when the object is used as a type.
(Inherited from Component) |
| GetScreenLabelInfo | (Overrides ComponentGetScreenLabelInfo) |
| GetTransformInterpolated | (Inherited from ObjectInSpace) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| IsMethodInvoking |
Checks if a method is running over time. You can start executing such methods using MethodInvoke(String, Object, Double, Double) method.
(Inherited from Component) |
| LookAt(ObjectInSpace) | (Inherited from ObjectInSpace) |
| LookAt(Vector3) | (Inherited from ObjectInSpace) |
| LookAt(ObjectInSpace, Vector3) | (Inherited from ObjectInSpace) |
| LookAt(Vector3, Vector3) | (Inherited from ObjectInSpace) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| MetadataGetMemberBySignature |
Returns the object metadata member by name.
(Inherited from Component) |
| MetadataGetMembers |
Returns the object metadata members.
(Inherited from Component) |
| MethodInvoke |
Calls a method by name.
(Inherited from Component) |
| MethodInvokeCancel |
Cancels the execution of selected method that run over time. You can start executing such methods using MethodInvoke(String, Object, Double, Double) method.
(Inherited from Component) |
| MethodInvokeCancelAll |
Cancels the execution of all methods that run over time. You can start executing such methods using MethodInvoke(String, Object, Double, Double) method.
(Inherited from Component) |
| NetworkDisablePropertySynchronization | (Inherited from Component) |
| NetworkIsDisabledPropertySynchronization | (Inherited from Component) |
| NetworkModeAddUser | (Inherited from Component) |
| NetworkModeIsEnabledForUser | (Inherited from Component) |
| NetworkModeRemoveUser | (Inherited from Component) |
| NetworkRestoreDisabledPropertySynchronization | (Inherited from Component) |
| NewObjectSetDefaultConfiguration |
Called when the object is created in the editor. Designed to configure the initial state.
(Inherited from Component) |
| NewObjectSetDefaultConfigurationUpdate |
Called during object creation in the editor. Designed to configure the initial state.
(Inherited from Component) |
| OnAddedToParent | (Inherited from ObjectInSpace) |
| OnBeforePlay | |
| OnCheckSelectionByRay | (Inherited from ObjectInSpace) |
| OnClientConnectedAfterRootComponentEnabled | (Inherited from Component) |
| OnClientConnectedBeforeRootComponentEnabled | (Inherited from Component) |
| OnClientDisconnected | (Inherited from Component) |
| OnClone |
Called when the object is cloned.
(Inherited from Component) |
| OnComponentAdded |
Called when a child component is added.
(Inherited from Component) |
| OnComponentRemoved |
Called when a child component is removed.
(Inherited from Component) |
| OnDisabledInSimulation |
Called when the object is detached from a hierarchy of the components or is disabled. The method is called only in simulation application. See also EnabledInHierarchy property.
(Inherited from Component) |
| OnDisabledInSimulationAndIsInstance |
Called when the object is detached from a hierarchy of the components or is disabled, which was created as an instance (is not resource). The method is called only in simulation application. See also EnabledInHierarchy property.
(Inherited from Component) |
| OnDispose |
Called when the object is disposed.
(Inherited from Component) |
| OnEditorGetTextInfoCenterBottomCorner | (Inherited from Component) |
| OnEnabledChanged |
Called when value of Enabled property is changed.
(Inherited from Component) |
| OnEnabledInHierarchyChanged | (Overrides ObjectInSpaceOnEnabledInHierarchyChanged) |
| OnEnabledInSimulation |
Called when the object is attached to a hierarchy of the components and is enabled. The method is called only in simulation application. See also EnabledInHierarchy property.
(Inherited from Component) |
| OnEnabledInSimulationAndIsInstance |
Called when the object is attached to a hierarchy of the components, it is enabled, which was created as an instance (is not resource). The method is called only in simulation application. See also EnabledInHierarchy property.
(Inherited from Component) |
| OnEnabledSelectionByCursor | (Inherited from ObjectInSpace) |
| OnGetRenderSceneData | (Overrides ObjectInSpaceOnGetRenderSceneData(ViewportRenderingContext, GetRenderSceneDataMode, SceneGetObjectsInSpaceItem)) |
| OnGetSceneObjectFlags | (Inherited from ObjectInSpace) |
| OnLifetimeEnd | (Inherited from ObjectInSpace) |
| OnLoad |
Called during object loading.
(Inherited from Component) |
| OnMetadataGetMemberBySignature |
Called when the object metadata member is received by name.
(Inherited from Component) |
| OnMetadataGetMembers |
Called upon receipt of the object's metadata members.
(Inherited from Component) |
| OnMetadataGetMembersFilter | (Overrides ComponentOnMetadataGetMembersFilter(MetadataGetMembersContext, MetadataMember, Boolean)) |
| OnOcclusionCullingDataGet | (Inherited from ObjectInSpace) |
| OnPreloadResources |
Called when preloading the resources used by the object.
(Inherited from Component) |
| OnReceiveNetworkMessageFromClient | (Inherited from Component) |
| OnReceiveNetworkMessageFromServer | (Inherited from Component) |
| OnRemovedFromParent | (Inherited from ObjectInSpace) |
| OnSave |
Called during object saving.
(Inherited from Component) |
| OnSimulationStep | (Overrides ObjectInSpaceOnSimulationStep) |
| OnSimulationStepClient | (Inherited from ObjectInSpace) |
| OnSpaceBoundsUpdate | (Overrides ObjectInSpaceOnSpaceBoundsUpdate(SpaceBounds)) |
| OnSpaceBoundsUpdateIncludeChildren | (Inherited from ObjectInSpace) |
| OnTransformChanged | (Overrides ObjectInSpaceOnTransformChanged) |
| OnTransformUpdating | (Inherited from ObjectInSpace) |
| OnUpdate | (Overrides ComponentOnUpdate(Single)) |
| PreloadResources |
Preload resources used by the object.
(Inherited from Component) |
| PropertyGet(String, Object, Boolean) |
Gets the value of a property by name.
(Inherited from Component) |
| PropertySet |
Sets the value of a property by name.
(Inherited from Component) |
| RemoveAllComponents |
Removes all child components.
(Inherited from Component) |
| RemoveComponent |
Removes a child component.
(Inherited from Component) |
| RemoveFromParent |
Detaches the object from its parent.
(Inherited from Component) |
| SetPosition(Vector3) | (Inherited from ObjectInSpace) |
| SetPosition(Double, Double, Double) | (Inherited from ObjectInSpace) |
| SetRotation(Angles) | (Inherited from ObjectInSpace) |
| SetRotation(Quaternion) | (Inherited from ObjectInSpace) |
| SetRotation(Double, Double, Double) | (Inherited from ObjectInSpace) |
| SetScale(Double) | (Inherited from ObjectInSpace) |
| SetScale(Vector3) | (Inherited from ObjectInSpace) |
| SetScale(Double, Double, Double) | (Inherited from ObjectInSpace) |
| SpaceBoundsUpdate | (Inherited from ObjectInSpace) |
| ToString |
Returns the name and type of the object as a string.
(Inherited from Component) |
| TransformInterpolatedReset | (Inherited from ObjectInSpace) |
| TypeSettingsIsPublic |
Checks whether the object provided as a type is public.
(Inherited from Component) |
| TypeSettingsIsPublicMember |
Checks whether the member is set up as public.
(Inherited from Component) |
Events| Name | Description | |
|---|---|---|
 | AddedToParent |
Occurs when a component is added to the parent.
(Inherited from Component) |
| AttenuationFarChanged | Occurs when the AttenuationFar property value changes. |
| AttenuationNearChanged | Occurs when the AttenuationNear property value changes. |
| BeforePlayEvent | |
| CanBeSelectedChanged | Occurs when the CanBeSelected property value changes. (Inherited from ObjectInSpace) |
| CloneEvent |
Occurs when object is cloned.
(Inherited from Component) |
| CloneSupportChanged |
Occurs after changing value of CloneSupport property.
(Inherited from Component) |
| ComponentAdded |
Occurs when a child component is added.
(Inherited from Component) |
| ComponentRemoved |
Occurs when a child component is removed.
(Inherited from Component) |
| ComponentsChanged |
Occurs when the set of children is changed.
(Inherited from Component) |
| DisabledInSimulation |
Occurs when the object is detached from a hierarchy of the components or is disabled. The method is called only in simulation application. See also EnabledInHierarchy property.
(Inherited from Component) |
| DisabledInSimulationAndIsInstance |
Occurs when the object is detached from a hierarchy of the components or is disabled, which was created as an instance (is not resource). The method is called only in simulation application. See also EnabledInHierarchy property.
(Inherited from Component) |
| DisplayInEditorChanged |
Occurs when value of DisplayInEditor property is changed.
(Inherited from Component) |
| DisposeEvent |
Occurs when the object is disposed.
(Inherited from Component) |
| EnabledChanged |
Occurs when the Enabled property value changes.
(Inherited from Component) |
| EnabledInHierarchyChanged |
Occurs when the EnabledInHierarchy property value changes.
(Inherited from Component) |
| EnabledInSimulation |
Occurs when the object is attached to a hierarchy of the components and is enabled. The method is called only in simulation application. See also EnabledInHierarchy property.
(Inherited from Component) |
| EnabledInSimulationAndIsInstance |
Occurs when the object is attached to a hierarchy of the components, it is enabled, which was created as an instance (is not resource). The method is called only in simulation application. See also EnabledInHierarchy property.
(Inherited from Component) |
| GetRenderSceneData | (Inherited from ObjectInSpace) |
| GetRenderSceneDataBefore | (Inherited from ObjectInSpace) |
| LifetimeEnd | (Inherited from ObjectInSpace) |
| LoadEvent |
Occurs during object loading.
(Inherited from Component) |
| MetadataGetMemberBySignatureEvent |
Occurs when the object metadata member is received by name.
(Inherited from Component) |
| MetadataGetMembersEvent |
Occurs upon receipt of the object's metadata members.
(Inherited from Component) |
| MetadataGetMembersFilterEvent |
Occurs when filtering receive members of the object metadata.
(Inherited from Component) |
| Mode3DChanged | Occurs when the Mode3D property value changes. |
| NameChanged |
Occurs when component name is changed.
(Inherited from Component) |
| NetworkModeChanged | Occurs when the NetworkMode property value changes. (Inherited from Component) |
| PitchChanged | Occurs when the Pitch property value changes. |
| PreloadResourcesEvent |
Occurs when preloading the resources used by the object.
(Inherited from Component) |
| PriorityChanged | Occurs when the Priority property value changes. |
| ReceiveNetworkMessageFromClient | (Inherited from Component) |
| ReceiveNetworkMessageFromServer | (Inherited from Component) |
| RemainingLifetimeChanged | Occurs when the RemainingLifetime property value changes. (Inherited from ObjectInSpace) |
| RemovedFromParent |
Occurs when a component is removed from the parent.
(Inherited from Component) |
| ReplayDelayChanged | Occurs when the ReplayDelay property value changes. |
| RolloffLogarithmicFactorChanged | Occurs when the RolloffLogarithmicFactor property value changes. |
| RolloffModeChanged | Occurs when the RolloffMode property value changes. |
| SaveEvent |
Occurs during object saving.
(Inherited from Component) |
| SaveSupportChanged |
Occurs after changing value of SaveSupport property.
(Inherited from Component) |
| ScreenLabelChanged | Occurs when the ScreenLabel property value changes. (Inherited from Component) |
| SimulationStep |
Occurs during the simulation step.
(Inherited from Component) |
| SimulationStepClient |
Occurs during the simulation step.
(Inherited from Component) |
| SoundChanged | Occurs when the Sound property value changes. |
| SpaceBoundsUpdateEvent | (Inherited from ObjectInSpace) |
| SpaceBoundsUpdateIncludeChildrenEvent | (Inherited from ObjectInSpace) |
| StreamingChanged | Occurs when the Streaming property value changes. |
| TransformChanged | Occurs when the Transform property value changes. (Inherited from ObjectInSpace) |
| TransformInterpolationChanged | Occurs when the TransformInterpolation property value changes. (Inherited from ObjectInSpace) |
| UpdateEvent |
Occurs during the update process of all objects.
(Inherited from Component) |
| VisibleChanged | Occurs when the Visible property value changes. (Inherited from ObjectInSpace) |
| VolumeChanged | Occurs when the Volume property value changes. |
Fields| Name | Description | |
|---|---|---|
 | EditorCameraTransform | (Inherited from ObjectInSpace) |
Extension Methods| Name | Description | |
|---|---|---|
 | MethodInvoke |
Calls the object method by name.
(Defined by ObjectEx) |
| PropertyGet |
Gets the value of the object property by name.
(Defined by ObjectEx) |
| PropertyGetT |
Gets the value of the object property by name.
(Defined by ObjectEx) |
| PropertySet |
Sets the value of the object property by name.
(Defined by ObjectEx) |
See Also