All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
spatialAudio.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #ifndef USDMEDIA_GENERATED_SPATIALAUDIO_H
25 #define USDMEDIA_GENERATED_SPATIALAUDIO_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdMedia/api.h"
31 #include "pxr/usd/usdGeom/xformable.h"
32 #include "pxr/usd/usd/prim.h"
33 #include "pxr/usd/usd/stage.h"
34 #include "pxr/usd/usdMedia/tokens.h"
35 
36 #include "pxr/base/vt/value.h"
37 
38 #include "pxr/base/gf/vec3d.h"
39 #include "pxr/base/gf/vec3f.h"
40 #include "pxr/base/gf/matrix4d.h"
41 
42 #include "pxr/base/tf/token.h"
43 #include "pxr/base/tf/type.h"
44 
45 PXR_NAMESPACE_OPEN_SCOPE
46 
47 class SdfAssetPath;
48 
49 // -------------------------------------------------------------------------- //
50 // SPATIALAUDIO //
51 // -------------------------------------------------------------------------- //
52 
109 {
110 public:
115 
120  explicit UsdMediaSpatialAudio(const UsdPrim& prim=UsdPrim())
121  : UsdGeomXformable(prim)
122  {
123  }
124 
128  explicit UsdMediaSpatialAudio(const UsdSchemaBase& schemaObj)
129  : UsdGeomXformable(schemaObj)
130  {
131  }
132 
134  USDMEDIA_API
135  virtual ~UsdMediaSpatialAudio();
136 
140  USDMEDIA_API
141  static const TfTokenVector &
142  GetSchemaAttributeNames(bool includeInherited=true);
143 
153  USDMEDIA_API
154  static UsdMediaSpatialAudio
155  Get(const UsdStagePtr &stage, const SdfPath &path);
156 
179  USDMEDIA_API
180  static UsdMediaSpatialAudio
181  Define(const UsdStagePtr &stage, const SdfPath &path);
182 
183 protected:
187  USDMEDIA_API
188  UsdSchemaType _GetSchemaType() const override;
189 
190 private:
191  // needs to invoke _GetStaticTfType.
192  friend class UsdSchemaRegistry;
193  USDMEDIA_API
194  static const TfType &_GetStaticTfType();
195 
196  static bool _IsTypedSchema();
197 
198  // override SchemaBase virtuals.
199  USDMEDIA_API
200  const TfType &_GetTfType() const override;
201 
202 public:
203  // --------------------------------------------------------------------- //
204  // FILEPATH
205  // --------------------------------------------------------------------- //
221  USDMEDIA_API
223 
229  USDMEDIA_API
230  UsdAttribute CreateFilePathAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
231 
232 public:
233  // --------------------------------------------------------------------- //
234  // AURALMODE
235  // --------------------------------------------------------------------- //
255  USDMEDIA_API
257 
263  USDMEDIA_API
264  UsdAttribute CreateAuralModeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
265 
266 public:
267  // --------------------------------------------------------------------- //
268  // PLAYBACKMODE
269  // --------------------------------------------------------------------- //
296  USDMEDIA_API
298 
304  USDMEDIA_API
305  UsdAttribute CreatePlaybackModeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
306 
307 public:
308  // --------------------------------------------------------------------- //
309  // STARTTIME
310  // --------------------------------------------------------------------- //
327  USDMEDIA_API
329 
335  USDMEDIA_API
336  UsdAttribute CreateStartTimeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
337 
338 public:
339  // --------------------------------------------------------------------- //
340  // ENDTIME
341  // --------------------------------------------------------------------- //
361  USDMEDIA_API
363 
369  USDMEDIA_API
370  UsdAttribute CreateEndTimeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
371 
372 public:
373  // --------------------------------------------------------------------- //
374  // MEDIAOFFSET
375  // --------------------------------------------------------------------- //
390  USDMEDIA_API
392 
398  USDMEDIA_API
399  UsdAttribute CreateMediaOffsetAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
400 
401 public:
402  // --------------------------------------------------------------------- //
403  // GAIN
404  // --------------------------------------------------------------------- //
414  USDMEDIA_API
415  UsdAttribute GetGainAttr() const;
416 
422  USDMEDIA_API
423  UsdAttribute CreateGainAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
424 
425 public:
426  // ===================================================================== //
427  // Feel free to add custom code below this line, it will be preserved by
428  // the code generator.
429  //
430  // Just remember to:
431  // - Close the class declaration with };
432  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
433  // - Close the include guard with #endif
434  // ===================================================================== //
435  // --(BEGIN CUSTOM CODE)--
436 };
437 
438 PXR_NAMESPACE_CLOSE_SCOPE
439 
440 #endif
USDMEDIA_API UsdAttribute CreateAuralModeAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetAuralModeAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDMEDIA_API UsdAttribute GetAuralModeAttr() const
Determines how audio should be played.
USDMEDIA_API UsdAttribute CreateMediaOffsetAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetMediaOffsetAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDMEDIA_API UsdAttribute CreateGainAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetGainAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
virtual USDMEDIA_API ~UsdMediaSpatialAudio()
Destructor.
USDMEDIA_API UsdAttribute CreateFilePathAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetFilePathAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
Scenegraph object for authoring and retrieving numeric, string, and array valued data, sampled over time.
Definition: attribute.h:176
static USDMEDIA_API const TfTokenVector & GetSchemaAttributeNames(bool includeInherited=true)
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor cl...
Represents a concrete typed schema.
USDMEDIA_API UsdAttribute GetMediaOffsetAttr() const
Expressed in seconds, mediaOffset specifies the offset from the referenced audio file's beginning at ...
USDMEDIA_API UsdAttribute GetPlaybackModeAttr() const
Along with startTime and endTime, determines when the audio playback should start and stop during the...
UsdMediaSpatialAudio(const UsdPrim &prim=UsdPrim())
Construct a UsdMediaSpatialAudio on UsdPrim prim .
Definition: spatialAudio.h:120
USDMEDIA_API UsdAttribute GetEndTimeAttr() const
Expressed in the timeCodesPerSecond of the containing stage, endTime specifies when the audio stream ...
static USDMEDIA_API UsdMediaSpatialAudio Define(const UsdStagePtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefin...
USDMEDIA_API UsdAttribute CreateEndTimeAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetEndTimeAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDMEDIA_API UsdAttribute GetFilePathAttr() const
Path to the audio file.
UsdSchemaType
An enum representing which type of schema a given schema class belongs to.
Definition: common.h:127
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:132
USDMEDIA_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
USDMEDIA_API UsdAttribute CreatePlaybackModeAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetPlaybackModeAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
static USDMEDIA_API UsdMediaSpatialAudio Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdMediaSpatialAudio holding the prim adhering to this schema at path on stage...
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:288
UsdMediaSpatialAudio(const UsdSchemaBase &schemaObj)
Construct a UsdMediaSpatialAudio on the prim held by schemaObj .
Definition: spatialAudio.h:128
USDMEDIA_API UsdAttribute CreateStartTimeAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetStartTimeAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
Definition: spatialAudio.h:114
USDMEDIA_API UsdAttribute GetGainAttr() const
Multiplier on the incoming audio signal.
Contains an asset path and an optional resolved path.
Definition: assetPath.h:43
TfType represents a dynamic runtime type.
Definition: type.h:64
Singleton registry that provides access to schema type information and the prim definitions for regis...
The base class for all schema types in Usd.
Definition: schemaBase.h:56
Base class for all transformable prims, which allows arbitrary sequences of component affine transfor...
Definition: xformable.h:252
The SpatialAudio primitive defines basic properties for encoding playback of an audio file or stream ...
Definition: spatialAudio.h:108
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:168
USDMEDIA_API UsdAttribute GetStartTimeAttr() const
Expressed in the timeCodesPerSecond of the containing stage, startTime specifies when the audio strea...