com.beaglebuddy.id3.v23.frame_body

## Class ID3v23FrameBodyPlayCounter

- java.lang.Object
- - com.beaglebuddy.id3.v23.frame_body.ID3v23FrameBodyUtility
  - - com.beaglebuddy.id3.v23.frame_body.ID3v23FrameBody
    - - com.beaglebuddy.id3.v23.frame_body.ID3v23FrameBodyPlayCounter

-     public class ID3v23FrameBodyPlayCounter
      extends ID3v23FrameBody

  A play counter frame body is associated with an ID3v2.3 `PCNT` `frame` which is used to count the number of times an .mp3 file has been played. The value is increased by one every time the file begins to play. The play counter frame body contains the following fields:

  Play Counter Frame Body Fields
  | Field | Description
  --- | --- | ---
  1. | counter | number of times the .mp3 file has been played.

  There may only be one play counter frame in each tag.

  See Also:
    `ID3v23Frame`, ID3 tag version 2.3.0 standard, wikipedia history of ID3 tags

- - ### Field Summary

    - ### Fields inherited from class com.beaglebuddy.id3.v23.frame_body.ID3v23FrameBody

      `buffer, dirty, frameType`

    - ### Fields inherited from class com.beaglebuddy.id3.v23.frame_body.ID3v23FrameBodyUtility

      `nextNullTerminatorIndex, nullTerminatorIndex`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `ID3v23FrameBodyPlayCounter()` The default constructor is called when creating a new frame.
    `ID3v23FrameBodyPlayCounter(java.io.InputStream inputStream, int frameBodySize)` This constructor is called when reading in an existing frame from an .mp3 file.
    `ID3v23FrameBodyPlayCounter(int counter)` This constructor is called when creating a new frame.

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `int` | `getCounter()` gets the number of times the song has been played.
    `void` | `parse()` parses the raw bytes of the frame body and stores the parsed values in the frame's fields.
    `void` | `setBuffer()` If the frame body's values have been modified, then resize the raw binary buffer and store the new values there.
    `void` | `setCounter(int counter)` sets the number of times the song has been played.
    `java.lang.String` | `toString()` gets a string representation of the play counter frame body showing all of the frame's fields and their values.

    - ### Methods inherited from class com.beaglebuddy.id3.v23.frame_body.ID3v23FrameBody

      `getFrameType, getNextNullTerminator, getSize, isDirty, save, save`

    - ### Methods inherited from class com.beaglebuddy.id3.v23.frame_body.ID3v23FrameBodyUtility

      `bytesToInt, bytesToShort, bytesToSynchsafeInt, bytesToSynchsafeShort, formateDate, getNextNullTerminator, hex, hex, intToBytes, pad, pricesToString, shortToBytes, stringToBytes, synchsafeIntToBytes`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- - ### Constructor Detail

    - #### ID3v23FrameBodyPlayCounter

          public ID3v23FrameBodyPlayCounter()

      The default constructor is called when creating a new frame. The default values used are:
      - counter at 0

    - #### ID3v23FrameBodyPlayCounter

          public ID3v23FrameBodyPlayCounter(int counter)

      This constructor is called when creating a new frame.
      Parameters:
        `counter` - the number of times the song has been played.

    - #### ID3v23FrameBodyPlayCounter

          public ID3v23FrameBodyPlayCounter(java.io.InputStream inputStream,
                                    int frameBodySize)
                                     throws java.io.IOException

      This constructor is called when reading in an existing frame from an .mp3 file. This is then followed by a call to the parse() method.
      Parameters:
        `inputStream` - input stream pointing to a play counter frame body in the .mp3 file.
        `frameBodySize` - size (in bytes) of the frame's body.
      Throws:
        `java.io.IOException` - if there is an error while reading the frame body.

  - ### Method Detail

    - #### parse

          public void parse()
                     throws java.lang.IllegalArgumentException

      parses the raw bytes of the frame body and stores the parsed values in the frame's fields.
      Overrides:
        `parse` in class `ID3v23FrameBody`
      Throws:
        `java.lang.IllegalArgumentException` - if an invalid value is detected while parsing the frame body's raw bytes.

    - #### getCounter

          public int getCounter()

      gets the number of times the song has been played.
      Returns:
        the number of times the song has been played.
      See Also:
        `setCounter(int)`

    - #### setCounter

          public void setCounter(int counter)

      sets the number of times the song has been played.
      Parameters:
        `counter` - the number of times the song has been played.
      See Also:
        `getCounter()`

    - #### setBuffer

          public void setBuffer()

      If the frame body's values have been modified, then resize the raw binary buffer and store the new values there. When finished, the dirty flag is reset to indicate that the buffer is up to date, and the frame is now ready to be saved to the .mp3 file.
      Overrides:
        `setBuffer` in class `ID3v23FrameBody`

    - #### toString

          public java.lang.String toString()

      gets a string representation of the play counter frame body showing all of the frame's fields and their values.
      Overrides:
        `toString` in class `java.lang.Object`
      Returns:
        a string representation of the frame body.