
########################
A3DPDFRichMediaAnnotData
########################

.. c:struct:: A3DPDFRichMediaAnnotData

   :c:struct:`~A3DPDFRichMediaAnnotData`\ structure: options for the RichMedia annot behavior in the PDF.
   
   
      12.2
   
   
   
   Index
   =====
   
   .. rubric:: Variables
   
   
   .. rst-class:: api-xref-list
   
   
   * :c:member:`~A3DPDFRichMediaAnnotData.m_eActivateWhen`
   * :c:member:`~A3DPDFRichMediaAnnotData.m_eDesactivateWhen`
   * :c:member:`~A3DPDFRichMediaAnnotData.m_iBorderWidth`
   * :c:member:`~A3DPDFRichMediaAnnotData.m_ePlaybackControlsSkin`
   * :c:member:`~A3DPDFRichMediaAnnotData.m_sPlaybackControlsColor`
   * :c:member:`~A3DPDFRichMediaAnnotData.m_iPlaybackControlsOpacity`
   * :c:member:`~A3DPDFRichMediaAnnotData.m_bPlaybackControlsAutohide`
   * :c:member:`~A3DPDFRichMediaAnnotData.m_iPlayerVolume`
   * :c:member:`~A3DPDFRichMediaAnnotData.m_pPosterImage`
   * :c:member:`~A3DPDFRichMediaAnnotData.m_pcName`
   
   



.. rst-class:: kind-group kind-variable

.. rubric:: Variables
   :class: kind-group-title


.. c:member:: A3DPDFEActivateWhen A3DPDFRichMediaAnnotData.m_eActivateWhen

      .. rst-class:: sig-pretty-signature
      
         | :c:enum:`~A3DPDFEActivateWhen`
      
      Option to specify when the RichMedia annot should be activated.
      



.. c:member:: A3DPDFEDesactivateWhen A3DPDFRichMediaAnnotData.m_eDesactivateWhen

      .. rst-class:: sig-pretty-signature
      
         | :c:enum:`~A3DPDFEDesactivateWhen`
      
      Option to specify when the RichMedia annot should be deactivated.
      



.. c:member:: A3DInt32 A3DPDFRichMediaAnnotData.m_iBorderWidth

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DInt32`
      
      Border width in points.
      
      0 for an invisible border.
      



.. c:member:: A3DPDFEPlaybackControlsSkin A3DPDFRichMediaAnnotData.m_ePlaybackControlsSkin

      .. rst-class:: sig-pretty-signature
      
         | :c:enum:`~A3DPDFEPlaybackControlsSkin`
      
      Option to specify the controls that should be present for the RichMedia annot.
      



.. c:member:: A3DPDFRgbColorData A3DPDFRichMediaAnnotData.m_sPlaybackControlsColor

      .. rst-class:: sig-pretty-signature
      
         | :c:struct:`~A3DPDFRgbColorData`
      
      PlaybackControls color.
      



.. c:member:: A3DInt32 A3DPDFRichMediaAnnotData.m_iPlaybackControlsOpacity

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DInt32`
      
      PlaybackControls opacity.
      
      Values are from 0 (transparent) to 100 (opaque).
      



.. c:member:: A3DBool A3DPDFRichMediaAnnotData.m_bPlaybackControlsAutohide

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DBool`
      
      PlaybackControls auto hiding.
      



.. c:member:: A3DInt32 A3DPDFRichMediaAnnotData.m_iPlayerVolume

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DInt32`
      
      Playbacker volume.
      
      Values are from 0 (mute) to 100.
      



.. c:member:: A3DPDFImage* A3DPDFRichMediaAnnotData.m_pPosterImage

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DPDFImage`\ \*
      
      Specifies a poster image to be displayed when the RichMedia Annot is not activated.
      
      Null can not be specified.
      



.. c:member:: A3DUTF8Char* A3DPDFRichMediaAnnotData.m_pcName

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DUTF8Char`\ \*
      
      Name of the RichMedia Annot.
      
      If NULL is specified, the name is automatically generated.
      




