Class: TagLib::Ogg::File

Inherits:
File
  • Object
show all
Defined in:
lib/TagLib_doc.rb

Overview

An implementation of TagLib::File with some helpers for Ogg based formats. .

This is an implementation of Ogg file page and packet rendering and is of use to Ogg based formats. While the API is small this handles the non-trivial details of breaking up an Ogg stream into packets and makes these available (via subclassing) to the codec meta data implementations.

Instance Method Summary collapse

Instance Method Details

#audioPropertiesObject



976
977
# File 'lib/TagLib_doc.rb', line 976

def audioProperties()
end

#clearObject



945
946
# File 'lib/TagLib_doc.rb', line 945

def clear()
end

#find1Object



965
966
# File 'lib/TagLib_doc.rb', line 965

def find1()
end

#find2Object



980
981
# File 'lib/TagLib_doc.rb', line 980

def find2()
end

#find3Object



930
931
# File 'lib/TagLib_doc.rb', line 930

def find3()
end

#firstPageHeaderObject

Returns a pointer to the PageHeader for the first page in the stream or null if the page could not be found.



985
986
# File 'lib/TagLib_doc.rb', line 985

def firstPageHeader()
end

#insertObject



972
973
# File 'lib/TagLib_doc.rb', line 972

def insert()
end

#isOpenObject



939
940
# File 'lib/TagLib_doc.rb', line 939

def isOpen()
end

#isValidObject



963
964
# File 'lib/TagLib_doc.rb', line 963

def isValid()
end

#isWritableObject



924
925
# File 'lib/TagLib_doc.rb', line 924

def isWritable()
end

#lastPageHeaderObject

Returns a pointer to the PageHeader for the last page in the stream or null if the page could not be found.



935
936
# File 'lib/TagLib_doc.rb', line 935

def lastPageHeader()
end

#lengthObject



987
988
# File 'lib/TagLib_doc.rb', line 987

def length()
end

#nameObject



926
927
# File 'lib/TagLib_doc.rb', line 926

def name()
end

#open?Boolean

Returns:

  • (Boolean)


961
962
# File 'lib/TagLib_doc.rb', line 961

def open?()
end

#packet(i) ⇒ Object

Returns the packet contents for the i-th packet (starting from zero) in the Ogg bitstream.The requires reading at least the packet header for every page up to the requested page.



955
956
# File 'lib/TagLib_doc.rb', line 955

def packet(i)
end

#read_only?Boolean

Returns:

  • (Boolean)


937
938
# File 'lib/TagLib_doc.rb', line 937

def read_only?()
end

#readBlockObject



941
942
# File 'lib/TagLib_doc.rb', line 941

def readBlock()
end

#readOnlyObject



974
975
# File 'lib/TagLib_doc.rb', line 974

def readOnly()
end

#removeBlockObject



957
958
# File 'lib/TagLib_doc.rb', line 957

def removeBlock()
end

#rfindObject



943
944
# File 'lib/TagLib_doc.rb', line 943

def rfind()
end

#saveObject

Save the file and its associated tags. This should be reimplemented in the concrete subclasses. Returns true if the save succeeds.On UNIX multiple processes are able to write to the same file at the same time. This can result in serious file corruption. If you are developing a program that makes use of TagLib from multiple processes you must insure that you are only doing writes to a particular file from one of them.



995
996
# File 'lib/TagLib_doc.rb', line 995

def save()
end

#seekObject



928
929
# File 'lib/TagLib_doc.rb', line 928

def seek()
end

#setPacket(i, p) ⇒ Object

Sets the packet with index i to the value p.



970
971
# File 'lib/TagLib_doc.rb', line 970

def setPacket(i,p)
end

#tagObject



947
948
# File 'lib/TagLib_doc.rb', line 947

def tag()
end

#tellObject



978
979
# File 'lib/TagLib_doc.rb', line 978

def tell()
end

#valid?Boolean

Returns:

  • (Boolean)


989
990
# File 'lib/TagLib_doc.rb', line 989

def valid?()
end

#writable?Boolean

Returns:

  • (Boolean)


959
960
# File 'lib/TagLib_doc.rb', line 959

def writable?()
end

#writeBlockObject



949
950
# File 'lib/TagLib_doc.rb', line 949

def writeBlock()
end