Packages

final case class ImageFileSeqOut(key: String, in: D, width: I, height: I, fileType: I = -1, sampleFormat: I = 0, quality: I = 80, indices: I) extends Expander[Unit] with Product with Serializable

A graph element that creates a UGen writing to a file sequence designated by an object attribute with a given key and the value being an Artifact.

If the given file-type GE is -1, the type is determined by this artifact. For example, if the artifact's path ends in ".png", the PNG format will used, if the path ends in ".jpg", then JPEG will be used. The default is PNG.

key

the key into the enclosing object's attribute map, pointing to an Artifact for the file template. The artifact's file name is taken as a template. Either that file contains a single placeholder for java.util.Formatter syntax, such as %d to insert an integer number. Or alternatively, if the file name does not contain a % character but a digit or a sequence of digits, those digits will be replaced by %d to produce a valid template. Therefore, if the template is foo-123.jpg and the indices contain 4 and 5, then the UGen will write the images foo-4 and foo-5 (the placeholder 123 is irrelevant).

in

the signal to write

width

image's width in pixels

height

image's height in pixels

fileType

a file type id as given by ImageFileSeqOut.id(). The default is -1 (auto-detect).

sampleFormat

a sample format id as given by ImageFileSeqOut.id(). The default is 0 (8-bit Int).

quality

the compression quality for a lossy format such as JPG. The default is 80.

Linear Supertypes
Serializable, Expander[Unit], Lazy, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ImageFileSeqOut
  2. Serializable
  3. Expander
  4. Lazy
  5. Product
  6. Equals
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ImageFileSeqOut(key: String, in: D, width: I, height: I, fileType: I = -1, sampleFormat: I = 0, quality: I = 80, indices: I)

    key

    the key into the enclosing object's attribute map, pointing to an Artifact for the file template. The artifact's file name is taken as a template. Either that file contains a single placeholder for java.util.Formatter syntax, such as %d to insert an integer number. Or alternatively, if the file name does not contain a % character but a digit or a sequence of digits, those digits will be replaced by %d to produce a valid template. Therefore, if the template is foo-123.jpg and the indices contain 4 and 5, then the UGen will write the images foo-4 and foo-5 (the placeholder 123 is irrelevant).

    in

    the signal to write

    width

    image's width in pixels

    height

    image's height in pixels

    fileType

    a file type id as given by ImageFileSeqOut.id(). The default is -1 (auto-detect).

    sampleFormat

    a sample format id as given by ImageFileSeqOut.id(). The default is 0 (8-bit Int).

    quality

    the compression quality for a lossy format such as JPG. The default is 80.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. val fileType: I
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  9. val height: I
  10. val in: D
  11. val indices: I
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. val key: String
  14. def makeUGens(implicit b: Builder): Unit

    Abstract method which must be implemented by creating the actual UGens during expansion.

    Abstract method which must be implemented by creating the actual UGens during expansion. This method is at most called once during graph expansion

    returns

    the expanded object (depending on the type parameter U)

    Attributes
    protected
    Definition Classes
    ImageFileSeqOutExpander
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. def productElementNames: Iterator[String]
    Definition Classes
    Product
  19. val quality: I
  20. val sampleFormat: I
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. val width: I

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Expander[Unit]

Inherited from Lazy

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped