AnnAudioObject Class

Summary

Defines an audio object.

Syntax

Objective-C

C++

Java

public class AnnAudioObject : AnnMediaObject

Public Class AnnAudioObject  
   Inherits AnnMediaObject 
   Implements IAnnObjectCloneable

@interface LTAnnAudioObject : LTAnnImageObject<NSCoding,NSCopying>

public class AnnAudioObject extends AnnMediaObject

public: 
   ref class AnnAudioObject : AnnMediaObject

Remarks

The AnnAudioObject derives from AnnMediaObject object and is designed to hold the URL to an audio file.

The AnnAudioObject object will draw the picture if the owner container is in design mode. If the container is in run mode, the AnnAudioObject object will not draw the picture, instead, the automation framework will either try to create a media control and play the URL into it or play it directly (depending on the type of the media file).

With the automated functions, in design mode, the rectangle contains a scaled image. The user clicks / taps and drags to specify the rectangle in the current window.

Programmatically, the boundaries and location of the audio object can be controlled using the following properties:

Each object can be transformed with the following methods:

The AnnAudioObject class inherits a number of properties from the AnnObject class, providing support for font, stroke and fill characteristics. These properties are listed below:

The name of the audio object can be controlled using AnnObject.Labels property, inherited from the AnnObject class.

An object can be part of a group annotation object or part of a container object. It cannot be part of both a group and a container at the same time.

The following properties can also be used to programmatically set characteristics of an AnnAudioObject:

Example

using LeadtoolsExamples.Common; 
using Leadtools.Annotations.Automation; 
using Leadtools.Annotations.Engine; 
using Leadtools.Codecs; 
using Leadtools.Annotations.WinForms; 
 
public void AnnCore_AnnAudioObject() 
{ 
   // assumes _automation is valid 
   double inch = 720.0; 
   // Add a Audio object 
   AnnAudioObject audioObj = new AnnAudioObject(); 
   // Set the points for the AnnAudioObject 
   audioObj.Points.Add(LeadPointD.Create(1 * inch, 1 * inch)); 
   audioObj.Points.Add(LeadPointD.Create(2 * inch, 1 * inch)); 
   audioObj.Points.Add(LeadPointD.Create(2 * inch, 2 * inch)); 
   audioObj.Points.Add(LeadPointD.Create(1 * inch, 2 * inch)); 
 
   // create the AnnMedia with a source to the media to play 
   AnnMedia media = new AnnMedia(); 
   //Replace the source with your audio file to be played on click 
   media.Source1 = "ms-appx:///Audio/TestAudio.mp3"; 
   audioObj.Media = media; 
   // Add the object to the automation container 
   _automation.Container.Children.Add(audioObj); 
}

Requirements

Target Platforms

Reference

AnnAudioObject Members

Leadtools.Annotations.Engine Namespace

Download our FREE evaluation

Help Version 20.0.2020.3.31

Leadtools.Annotations.Engine Assembly

Introduction

Getting Started

Namespaces

Leadtools.Annotations.Engine Namespace

Assemblies