OpenShot Library | OpenShotAudio 0.2.2
juce_FileInputSource.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
27namespace juce
28{
29
30//==============================================================================
31/**
32 A type of InputSource that represents a normal file.
33
34 @see InputSource
35
36 @tags{Core}
37*/
39{
40public:
41 //==============================================================================
42 /** Creates a FileInputSource for a file.
43 If the useFileTimeInHashGeneration parameter is true, then this object's
44 hashCode() method will incorporate the file time into its hash code; if
45 false, only the file name will be used for the hash.
46 */
47 FileInputSource (const File& file, bool useFileTimeInHashGeneration = false);
48
49 /** Destructor. */
50 ~FileInputSource() override;
51
52 InputStream* createInputStream() override;
53 InputStream* createInputStreamFor (const String& relatedItemPath) override;
54 int64 hashCode() const override;
55
56private:
57 //==============================================================================
58 const File file;
59 bool useFileTimeInHashGeneration;
60
61 JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (FileInputSource)
62};
63
64}
65
66/** @}*/
A type of InputSource that represents a normal file.
Represents a local file or directory.
Definition: juce_File.h:45
A lightweight object that can create a stream to read some kind of resource.
The base class for streams that read data.
The JUCE String class!
Definition: juce_String.h:43
#define JUCE_API
This macro is added to all JUCE public class declarations.