OpenShot Library | OpenShotAudio
0.2.2
juce_InputSource.h
1
2
/** @weakgroup juce_core-streams
3
* @{
4
*/
5
/*
6
==============================================================================
7
8
This file is part of the JUCE library.
9
Copyright (c) 2017 - ROLI Ltd.
10
11
JUCE is an open source library subject to commercial or open-source
12
licensing.
13
14
The code included in this file is provided under the terms of the ISC license
15
http://www.isc.org/downloads/software-support-policy/isc-license. Permission
16
To use, copy, modify, and/or distribute this software for any purpose with or
17
without fee is hereby granted provided that the above copyright notice and
18
this permission notice appear in all copies.
19
20
JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
21
EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
22
DISCLAIMED.
23
24
==============================================================================
25
*/
26
27
namespace
juce
28
{
29
30
//==============================================================================
31
/**
32
A lightweight object that can create a stream to read some kind of resource.
33
34
This may be used to refer to a file, or some other kind of source, allowing a
35
caller to create an input stream that can read from it when required.
36
37
@see FileInputSource
38
39
@tags{Core}
40
*/
41
class
JUCE_API
InputSource
42
{
43
public
:
44
//==============================================================================
45
InputSource
() =
default
;
46
47
/** Destructor. */
48
virtual
~InputSource
() =
default
;
49
50
//==============================================================================
51
/** Returns a new InputStream to read this item.
52
53
@returns an inputstream that the caller will delete, or nullptr if
54
the filename isn't found.
55
*/
56
virtual
InputStream
*
createInputStream
() = 0;
57
58
/** Returns a new InputStream to read an item, relative.
59
60
@param relatedItemPath the relative pathname of the resource that is required
61
@returns an inputstream that the caller will delete, or nullptr if
62
the item isn't found.
63
*/
64
virtual
InputStream
*
createInputStreamFor
(
const
String
& relatedItemPath) = 0;
65
66
/** Returns a hash code that uniquely represents this item.
67
*/
68
virtual
int64
hashCode
()
const
= 0;
69
70
71
private
:
72
//==============================================================================
73
JUCE_LEAK_DETECTOR (
InputSource
)
74
};
75
76
}
// namespace juce
77
78
/** @}*/
juce::InputSource
A lightweight object that can create a stream to read some kind of resource.
Definition:
juce_InputSource.h:42
juce::InputSource::hashCode
virtual int64 hashCode() const =0
Returns a hash code that uniquely represents this item.
juce::InputSource::createInputStreamFor
virtual InputStream * createInputStreamFor(const String &relatedItemPath)=0
Returns a new InputStream to read an item, relative.
juce::InputSource::createInputStream
virtual InputStream * createInputStream()=0
Returns a new InputStream to read this item.
juce::InputSource::~InputSource
virtual ~InputSource()=default
Destructor.
juce::InputStream
The base class for streams that read data.
Definition:
juce_InputStream.h:41
juce::String
The JUCE String class!
Definition:
juce_String.h:43
JUCE_API
#define JUCE_API
This macro is added to all JUCE public class declarations.
Definition:
juce_StandardHeader.h:146
juce_core
streams
juce_InputSource.h
Generated on Sun Mar 6 2022 19:35:30 for OpenShot Library | OpenShotAudio by
1.9.1