Skip to content

Commit

Permalink
Improve SeekRequest & Cue documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
xeruf committed Jun 18, 2020
1 parent b363848 commit 9c3c521
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 11 deletions.
21 changes: 10 additions & 11 deletions src/engine/enginebuffer.h
Original file line number Diff line number Diff line change
Expand Up @@ -89,19 +89,18 @@ class EngineBuffer : public EngineObject {
public:
enum SeekRequest {
SEEK_NONE = 0x00,
SEEK_PHASE = 0x01, // This is set to force an in-phase seek.
SEEK_EXACT = 0x02, // This is used to seek to position regardless of
// if Quantize is enabled.
/// Force an in-phase seek
SEEK_PHASE = 0x01,
/// Bypass Quantization
SEEK_EXACT = 0x02,
/// This is an artificial state that happens if an exact seek and a
/// phase seek are scheduled at the same time.
SEEK_EXACT_PHASE = SEEK_PHASE | SEEK_EXACT,
// This is an artificial state that happens if
// an exact seek and a phase seek are scheduled
// at the same time.
SEEK_STANDARD = 0x04, // This seeks to the exact position if Quantize is
// disabled or performs an in-phase seek if it is enabled.
/// #SEEK_PHASE if Quantize enables, otherwise SEEK_EXACT
SEEK_STANDARD = 0x04,
/// This is an artificial state that happens if a standard seek and a
/// phase seek are scheduled at the same time.
SEEK_STANDARD_PHASE = SEEK_STANDARD | SEEK_PHASE,
// This is an artificial state that happens if
// a standard seek and a phase seek are scheduled
// at the same time.
};
Q_DECLARE_FLAGS(SeekRequests, SeekRequest);

Expand Down
2 changes: 2 additions & 0 deletions src/track/cue.h
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@ class Cue : public QObject {
Q_OBJECT

public:
/// A position value for the cue that signals its position is not set
static constexpr double kNoPosition = -1.0;
/// A value for #m_iHotCue signaling it is not a hotcue
static constexpr int kNoHotCue = -1;

Cue();
Expand Down

0 comments on commit 9c3c521

Please sign in to comment.